Personalization Webservices

Actions

createAction

Creates an action


/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/actions

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/personalizationwebservices/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/actions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ActionsApi;

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

public class ActionsApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ActionsApi apiInstance = new ActionsApi();
        Action body = ; // Action | 
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String variationCode = variationCode_example; // String | Variation identifier
        try {
            action result = apiInstance.createAction(body, catalog, catalogVersion, customizationCode, variationCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActionsApi#createAction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ActionsApi;

public class ActionsApiExample {

    public static void main(String[] args) {
        ActionsApi apiInstance = new ActionsApi();
        Action body = ; // Action | 
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String variationCode = variationCode_example; // String | Variation identifier
        try {
            action result = apiInstance.createAction(body, catalog, catalogVersion, customizationCode, variationCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActionsApi#createAction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Action *body = ; // 
String *catalog = catalog_example; // Catalog identifier
String *catalogVersion = catalogVersion_example; // Catalog version identifier
String *customizationCode = customizationCode_example; // Customization identifier
String *variationCode = variationCode_example; // Variation identifier

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

// Creates an action
[apiInstance createActionWith:body
    catalog:catalog
    catalogVersion:catalogVersion
    customizationCode:customizationCode
    variationCode:variationCode
              completionHandler: ^(action output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.ActionsApi()
var body = ; // {{Action}} 
var catalog = catalog_example; // {{String}} Catalog identifier
var catalogVersion = catalogVersion_example; // {{String}} Catalog version identifier
var customizationCode = customizationCode_example; // {{String}} Customization identifier
var variationCode = variationCode_example; // {{String}} Variation identifier

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ActionsApi();
            var body = new Action(); // Action | 
            var catalog = catalog_example;  // String | Catalog identifier
            var catalogVersion = catalogVersion_example;  // String | Catalog version identifier
            var customizationCode = customizationCode_example;  // String | Customization identifier
            var variationCode = variationCode_example;  // String | Variation identifier

            try
            {
                // Creates an action
                action result = apiInstance.createAction(body, catalog, catalogVersion, customizationCode, variationCode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ActionsApi.createAction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiActionsApi();
$body = ; // Action | 
$catalog = catalog_example; // String | Catalog identifier
$catalogVersion = catalogVersion_example; // String | Catalog version identifier
$customizationCode = customizationCode_example; // String | Customization identifier
$variationCode = variationCode_example; // String | Variation identifier

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ActionsApi->new();
my $body = WWW::SwaggerClient::Object::Action->new(); # Action | 
my $catalog = catalog_example; # String | Catalog identifier
my $catalogVersion = catalogVersion_example; # String | Catalog version identifier
my $customizationCode = customizationCode_example; # String | Customization identifier
my $variationCode = variationCode_example; # String | Variation identifier

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ActionsApi()
body =  # Action | 
catalog = catalog_example # String | Catalog identifier
catalogVersion = catalogVersion_example # String | Catalog version identifier
customizationCode = customizationCode_example # String | Customization identifier
variationCode = variationCode_example # String | Variation identifier

try: 
    # Creates an action
    api_response = api_instance.create_action(body, catalog, catalogVersion, customizationCode, variationCode)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActionsApi->createAction: %s\n" % e)

Parameters

Path parameters
Name Description
catalog*
String
Catalog identifier
Required
catalogVersion*
String
Catalog version identifier
Required
customizationCode*
String
Customization identifier
Required
variationCode*
String
Variation identifier
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method or catalog with given id

Status: 404 - Catalog, customization or variation with given id doesn't exist

Status: 409 - Conflict - action with given code already exists


createActionSet

Creates set of actions in given variation and customization


/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/actions

Usage and SDK Samples

curl -X PATCH\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/personalizationwebservices/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/actions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ActionsApi;

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

public class ActionsApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ActionsApi apiInstance = new ActionsApi();
        ActionList body = ; // ActionList | 
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String variationCode = variationCode_example; // String | Variation identifier
        try {
            ActionList result = apiInstance.createActionSet(body, catalog, catalogVersion, customizationCode, variationCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActionsApi#createActionSet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ActionsApi;

public class ActionsApiExample {

    public static void main(String[] args) {
        ActionsApi apiInstance = new ActionsApi();
        ActionList body = ; // ActionList | 
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String variationCode = variationCode_example; // String | Variation identifier
        try {
            ActionList result = apiInstance.createActionSet(body, catalog, catalogVersion, customizationCode, variationCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActionsApi#createActionSet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
ActionList *body = ; // 
String *catalog = catalog_example; // Catalog identifier
String *catalogVersion = catalogVersion_example; // Catalog version identifier
String *customizationCode = customizationCode_example; // Customization identifier
String *variationCode = variationCode_example; // Variation identifier

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

// Creates set of actions in given variation and customization
[apiInstance createActionSetWith:body
    catalog:catalog
    catalogVersion:catalogVersion
    customizationCode:customizationCode
    variationCode:variationCode
              completionHandler: ^(ActionList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.ActionsApi()
var body = ; // {{ActionList}} 
var catalog = catalog_example; // {{String}} Catalog identifier
var catalogVersion = catalogVersion_example; // {{String}} Catalog version identifier
var customizationCode = customizationCode_example; // {{String}} Customization identifier
var variationCode = variationCode_example; // {{String}} Variation identifier

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ActionsApi();
            var body = new ActionList(); // ActionList | 
            var catalog = catalog_example;  // String | Catalog identifier
            var catalogVersion = catalogVersion_example;  // String | Catalog version identifier
            var customizationCode = customizationCode_example;  // String | Customization identifier
            var variationCode = variationCode_example;  // String | Variation identifier

            try
            {
                // Creates set of actions in given variation and customization
                ActionList result = apiInstance.createActionSet(body, catalog, catalogVersion, customizationCode, variationCode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ActionsApi.createActionSet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiActionsApi();
$body = ; // ActionList | 
$catalog = catalog_example; // String | Catalog identifier
$catalogVersion = catalogVersion_example; // String | Catalog version identifier
$customizationCode = customizationCode_example; // String | Customization identifier
$variationCode = variationCode_example; // String | Variation identifier

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ActionsApi->new();
my $body = WWW::SwaggerClient::Object::ActionList->new(); # ActionList | 
my $catalog = catalog_example; # String | Catalog identifier
my $catalogVersion = catalogVersion_example; # String | Catalog version identifier
my $customizationCode = customizationCode_example; # String | Customization identifier
my $variationCode = variationCode_example; # String | Variation identifier

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ActionsApi()
body =  # ActionList | 
catalog = catalog_example # String | Catalog identifier
catalogVersion = catalogVersion_example # String | Catalog version identifier
customizationCode = customizationCode_example # String | Customization identifier
variationCode = variationCode_example # String | Variation identifier

try: 
    # Creates set of actions in given variation and customization
    api_response = api_instance.create_action_set(body, catalog, catalogVersion, customizationCode, variationCode)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActionsApi->createActionSet: %s\n" % e)

Parameters

Path parameters
Name Description
catalog*
String
Catalog identifier
Required
catalogVersion*
String
Catalog version identifier
Required
customizationCode*
String
Customization identifier
Required
variationCode*
String
Variation identifier
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method or catalog with given id

Status: 404 - Catalog, customization or variation with given id doesn't exist

Status: 409 - Conflict - action with given code already exists


deleteAction

Deletes an existing action for a given customization and variation


/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/actions/{actionCode}

Usage and SDK Samples

curl -X DELETE\
\
\
"http://localhost:9001/personalizationwebservices/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/actions/{actionCode}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ActionsApi;

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

public class ActionsApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ActionsApi apiInstance = new ActionsApi();
        String actionCode = actionCode_example; // String | Action identifier
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String variationCode = variationCode_example; // String | Variation identifier
        try {
            apiInstance.deleteAction(actionCode, catalog, catalogVersion, customizationCode, variationCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActionsApi#deleteAction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ActionsApi;

public class ActionsApiExample {

    public static void main(String[] args) {
        ActionsApi apiInstance = new ActionsApi();
        String actionCode = actionCode_example; // String | Action identifier
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String variationCode = variationCode_example; // String | Variation identifier
        try {
            apiInstance.deleteAction(actionCode, catalog, catalogVersion, customizationCode, variationCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActionsApi#deleteAction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *actionCode = actionCode_example; // Action identifier
String *catalog = catalog_example; // Catalog identifier
String *catalogVersion = catalogVersion_example; // Catalog version identifier
String *customizationCode = customizationCode_example; // Customization identifier
String *variationCode = variationCode_example; // Variation identifier

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

// Deletes an existing action for a given customization and variation
[apiInstance deleteActionWith:actionCode
    catalog:catalog
    catalogVersion:catalogVersion
    customizationCode:customizationCode
    variationCode:variationCode
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.ActionsApi()
var actionCode = actionCode_example; // {{String}} Action identifier
var catalog = catalog_example; // {{String}} Catalog identifier
var catalogVersion = catalogVersion_example; // {{String}} Catalog version identifier
var customizationCode = customizationCode_example; // {{String}} Customization identifier
var variationCode = variationCode_example; // {{String}} Variation identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAction(actionCode, catalog, catalogVersion, customizationCode, variationCode, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ActionsApi();
            var actionCode = actionCode_example;  // String | Action identifier
            var catalog = catalog_example;  // String | Catalog identifier
            var catalogVersion = catalogVersion_example;  // String | Catalog version identifier
            var customizationCode = customizationCode_example;  // String | Customization identifier
            var variationCode = variationCode_example;  // String | Variation identifier

            try
            {
                // Deletes an existing action for a given customization and variation
                apiInstance.deleteAction(actionCode, catalog, catalogVersion, customizationCode, variationCode);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ActionsApi.deleteAction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiActionsApi();
$actionCode = actionCode_example; // String | Action identifier
$catalog = catalog_example; // String | Catalog identifier
$catalogVersion = catalogVersion_example; // String | Catalog version identifier
$customizationCode = customizationCode_example; // String | Customization identifier
$variationCode = variationCode_example; // String | Variation identifier

try {
    $api_instance->deleteAction($actionCode, $catalog, $catalogVersion, $customizationCode, $variationCode);
} catch (Exception $e) {
    echo 'Exception when calling ActionsApi->deleteAction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ActionsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ActionsApi->new();
my $actionCode = actionCode_example; # String | Action identifier
my $catalog = catalog_example; # String | Catalog identifier
my $catalogVersion = catalogVersion_example; # String | Catalog version identifier
my $customizationCode = customizationCode_example; # String | Customization identifier
my $variationCode = variationCode_example; # String | Variation identifier

eval { 
    $api_instance->deleteAction(actionCode => $actionCode, catalog => $catalog, catalogVersion => $catalogVersion, customizationCode => $customizationCode, variationCode => $variationCode);
};
if ($@) {
    warn "Exception when calling ActionsApi->deleteAction: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ActionsApi()
actionCode = actionCode_example # String | Action identifier
catalog = catalog_example # String | Catalog identifier
catalogVersion = catalogVersion_example # String | Catalog version identifier
customizationCode = customizationCode_example # String | Customization identifier
variationCode = variationCode_example # String | Variation identifier

try: 
    # Deletes an existing action for a given customization and variation
    api_instance.delete_action(actionCode, catalog, catalogVersion, customizationCode, variationCode)
except ApiException as e:
    print("Exception when calling ActionsApi->deleteAction: %s\n" % e)

Parameters

Path parameters
Name Description
actionCode*
String
Action identifier
Required
catalog*
String
Catalog identifier
Required
catalogVersion*
String
Catalog version identifier
Required
customizationCode*
String
Customization identifier
Required
variationCode*
String
Variation identifier
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method or catalog with given id

Status: 404 - Catalog, customization, variation or action with given id doesn't exist


deleteActionSet

Deletes a set of actions in given variation and customization


/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/actions

Usage and SDK Samples

curl -X DELETE\
\
\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/personalizationwebservices/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/actions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ActionsApi;

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

public class ActionsApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ActionsApi apiInstance = new ActionsApi();
        array[String] body = ; // array[String] | 
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String variationCode = variationCode_example; // String | Variation identifier
        try {
            apiInstance.deleteActionSet(body, catalog, catalogVersion, customizationCode, variationCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActionsApi#deleteActionSet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ActionsApi;

public class ActionsApiExample {

    public static void main(String[] args) {
        ActionsApi apiInstance = new ActionsApi();
        array[String] body = ; // array[String] | 
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String variationCode = variationCode_example; // String | Variation identifier
        try {
            apiInstance.deleteActionSet(body, catalog, catalogVersion, customizationCode, variationCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActionsApi#deleteActionSet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[String] *body = ; // 
String *catalog = catalog_example; // Catalog identifier
String *catalogVersion = catalogVersion_example; // Catalog version identifier
String *customizationCode = customizationCode_example; // Customization identifier
String *variationCode = variationCode_example; // Variation identifier

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

// Deletes a set of actions in given variation and customization
[apiInstance deleteActionSetWith:body
    catalog:catalog
    catalogVersion:catalogVersion
    customizationCode:customizationCode
    variationCode:variationCode
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.ActionsApi()
var body = ; // {{array[String]}} 
var catalog = catalog_example; // {{String}} Catalog identifier
var catalogVersion = catalogVersion_example; // {{String}} Catalog version identifier
var customizationCode = customizationCode_example; // {{String}} Customization identifier
var variationCode = variationCode_example; // {{String}} Variation identifier

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ActionsApi();
            var body = new array[String](); // array[String] | 
            var catalog = catalog_example;  // String | Catalog identifier
            var catalogVersion = catalogVersion_example;  // String | Catalog version identifier
            var customizationCode = customizationCode_example;  // String | Customization identifier
            var variationCode = variationCode_example;  // String | Variation identifier

            try
            {
                // Deletes a set of actions in given variation and customization
                apiInstance.deleteActionSet(body, catalog, catalogVersion, customizationCode, variationCode);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ActionsApi.deleteActionSet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiActionsApi();
$body = ; // array[String] | 
$catalog = catalog_example; // String | Catalog identifier
$catalogVersion = catalogVersion_example; // String | Catalog version identifier
$customizationCode = customizationCode_example; // String | Customization identifier
$variationCode = variationCode_example; // String | Variation identifier

try {
    $api_instance->deleteActionSet($body, $catalog, $catalogVersion, $customizationCode, $variationCode);
} catch (Exception $e) {
    echo 'Exception when calling ActionsApi->deleteActionSet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ActionsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ActionsApi->new();
my $body = [WWW::SwaggerClient::Object::array[String]->new()]; # array[String] | 
my $catalog = catalog_example; # String | Catalog identifier
my $catalogVersion = catalogVersion_example; # String | Catalog version identifier
my $customizationCode = customizationCode_example; # String | Customization identifier
my $variationCode = variationCode_example; # String | Variation identifier

eval { 
    $api_instance->deleteActionSet(body => $body, catalog => $catalog, catalogVersion => $catalogVersion, customizationCode => $customizationCode, variationCode => $variationCode);
};
if ($@) {
    warn "Exception when calling ActionsApi->deleteActionSet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ActionsApi()
body =  # array[String] | 
catalog = catalog_example # String | Catalog identifier
catalogVersion = catalogVersion_example # String | Catalog version identifier
customizationCode = customizationCode_example # String | Customization identifier
variationCode = variationCode_example # String | Variation identifier

try: 
    # Deletes a set of actions in given variation and customization
    api_instance.delete_action_set(body, catalog, catalogVersion, customizationCode, variationCode)
except ApiException as e:
    print("Exception when calling ActionsApi->deleteActionSet: %s\n" % e)

Parameters

Path parameters
Name Description
catalog*
String
Catalog identifier
Required
catalogVersion*
String
Catalog version identifier
Required
customizationCode*
String
Customization identifier
Required
variationCode*
String
Variation identifier
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method or catalog with given id

Status: 404 - Catalog, customization or variation with given id doesn't exist


getAction

Get an existing action for a given customization and variation


/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/actions/{actionCode}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/personalizationwebservices/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/actions/{actionCode}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ActionsApi;

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

public class ActionsApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ActionsApi apiInstance = new ActionsApi();
        String actionCode = actionCode_example; // String | Action identifier
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String variationCode = variationCode_example; // String | Variation identifier
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
        try {
            apiInstance.getAction(actionCode, catalog, catalogVersion, customizationCode, variationCode, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActionsApi#getAction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ActionsApi;

public class ActionsApiExample {

    public static void main(String[] args) {
        ActionsApi apiInstance = new ActionsApi();
        String actionCode = actionCode_example; // String | Action identifier
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String variationCode = variationCode_example; // String | Variation identifier
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
        try {
            apiInstance.getAction(actionCode, catalog, catalogVersion, customizationCode, variationCode, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActionsApi#getAction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *actionCode = actionCode_example; // Action identifier
String *catalog = catalog_example; // Catalog identifier
String *catalogVersion = catalogVersion_example; // Catalog version identifier
String *customizationCode = customizationCode_example; // Customization identifier
String *variationCode = variationCode_example; // Variation identifier
String *fields = fields_example; // Response configuration (list of fields, which should be returned in response) (optional)

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

// Get an existing action for a given customization and variation
[apiInstance getActionWith:actionCode
    catalog:catalog
    catalogVersion:catalogVersion
    customizationCode:customizationCode
    variationCode:variationCode
    fields:fields
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.ActionsApi()
var actionCode = actionCode_example; // {{String}} Action identifier
var catalog = catalog_example; // {{String}} Catalog identifier
var catalogVersion = catalogVersion_example; // {{String}} Catalog version identifier
var customizationCode = customizationCode_example; // {{String}} Customization identifier
var variationCode = variationCode_example; // {{String}} Variation identifier
var opts = { 
  'fields': fields_example // {{String}} Response configuration (list of fields, which should be returned in response)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getAction(actionCode, catalog, catalogVersion, customizationCode, variationCode, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ActionsApi();
            var actionCode = actionCode_example;  // String | Action identifier
            var catalog = catalog_example;  // String | Catalog identifier
            var catalogVersion = catalogVersion_example;  // String | Catalog version identifier
            var customizationCode = customizationCode_example;  // String | Customization identifier
            var variationCode = variationCode_example;  // String | Variation identifier
            var fields = fields_example;  // String | Response configuration (list of fields, which should be returned in response) (optional) 

            try
            {
                // Get an existing action for a given customization and variation
                apiInstance.getAction(actionCode, catalog, catalogVersion, customizationCode, variationCode, fields);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ActionsApi.getAction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiActionsApi();
$actionCode = actionCode_example; // String | Action identifier
$catalog = catalog_example; // String | Catalog identifier
$catalogVersion = catalogVersion_example; // String | Catalog version identifier
$customizationCode = customizationCode_example; // String | Customization identifier
$variationCode = variationCode_example; // String | Variation identifier
$fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)

try {
    $api_instance->getAction($actionCode, $catalog, $catalogVersion, $customizationCode, $variationCode, $fields);
} catch (Exception $e) {
    echo 'Exception when calling ActionsApi->getAction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ActionsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ActionsApi->new();
my $actionCode = actionCode_example; # String | Action identifier
my $catalog = catalog_example; # String | Catalog identifier
my $catalogVersion = catalogVersion_example; # String | Catalog version identifier
my $customizationCode = customizationCode_example; # String | Customization identifier
my $variationCode = variationCode_example; # String | Variation identifier
my $fields = fields_example; # String | Response configuration (list of fields, which should be returned in response)

eval { 
    $api_instance->getAction(actionCode => $actionCode, catalog => $catalog, catalogVersion => $catalogVersion, customizationCode => $customizationCode, variationCode => $variationCode, fields => $fields);
};
if ($@) {
    warn "Exception when calling ActionsApi->getAction: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ActionsApi()
actionCode = actionCode_example # String | Action identifier
catalog = catalog_example # String | Catalog identifier
catalogVersion = catalogVersion_example # String | Catalog version identifier
customizationCode = customizationCode_example # String | Customization identifier
variationCode = variationCode_example # String | Variation identifier
fields = fields_example # String | Response configuration (list of fields, which should be returned in response) (optional)

try: 
    # Get an existing action for a given customization and variation
    api_instance.get_action(actionCode, catalog, catalogVersion, customizationCode, variationCode, fields=fields)
except ApiException as e:
    print("Exception when calling ActionsApi->getAction: %s\n" % e)

Parameters

Path parameters
Name Description
actionCode*
String
Action identifier
Required
catalog*
String
Catalog identifier
Required
catalogVersion*
String
Catalog version identifier
Required
customizationCode*
String
Customization identifier
Required
variationCode*
String
Variation identifier
Required
Query parameters
Name Description
fields
String
Response configuration (list of fields, which should be returned in response)

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method or catalog with given id

Status: 404 - Catalog, customization, variation or action with given id doesn't exist


getActionList

Gets list of actions that fulfill search criteria with information about variation and customization


/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/actions

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/personalizationwebservices/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/actions?actionCode=&catalogs=&componentCatalog=&componentId=&containerId=¤tPage=&customizationCode=&customizationName=&customizationStatus=&fields=&needsTotal=&pageCatalogId=&pageId=&pageSize=&type=&variationCode=&variationName=&variationStatus="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ActionsApi;

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

public class ActionsApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ActionsApi apiInstance = new ActionsApi();
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String type = type_example; // String | Type of action. CXCMSACTION requires personalizationcms extension.
        String actionCode = actionCode_example; // String | Customization code. Supported by CXCMSACTION type.
        String catalogs = catalogs_example; // String | Filter for action catalog. Supported by CXCMSACTION type.
        String componentCatalog = componentCatalog_example; // String | Catalog of the action component. Supported by CXCMSACTION type.
        String componentId = componentId_example; // String | Id of the component used by the action. Supported by CXCMSACTION type.
        String containerId = containerId_example; // String | Id of the container used by the action. Supported by CXCMSACTION type.
        Integer currentPage = 56; // Integer | Current page number
        String customizationCode = customizationCode_example; // String | Customization code. Supported by CXCMSACTION type.
        String customizationName = customizationName_example; // String | Customization name. Supported by CXCMSACTION type.
        String customizationStatus = customizationStatus_example; // String | Comma separated customization statuses. Available statuses : ENABLED, DISABLED, DELETED. Supported by CXCMSACTION type.
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
        Boolean needsTotal = true; // Boolean | Request total count
        String pageCatalogId = pageCatalogId_example; // String | Catalog of the page action is affecting. Ignored if pageId is not provided. Supported by CXCMSACTION type.
        String pageId = pageId_example; // String | Id of the page affected by the action. Supported by CXCMSACTION type.
        Integer pageSize = 56; // Integer | Page size
        String variationCode = variationCode_example; // String | Variation code. Supported by CXCMSACTION type.
        String variationName = variationName_example; // String | Variation name. Supported by CXCMSACTION type.
        String variationStatus = variationStatus_example; // String | Comma separated variation statuses. Available statuses : ENABLED, DISABLED, DELETED. Supported by CXCMSACTION type.
        try {
            apiInstance.getActionList(catalog, catalogVersion, type, actionCode, catalogs, componentCatalog, componentId, containerId, currentPage, customizationCode, customizationName, customizationStatus, fields, needsTotal, pageCatalogId, pageId, pageSize, variationCode, variationName, variationStatus);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActionsApi#getActionList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ActionsApi;

public class ActionsApiExample {

    public static void main(String[] args) {
        ActionsApi apiInstance = new ActionsApi();
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String type = type_example; // String | Type of action. CXCMSACTION requires personalizationcms extension.
        String actionCode = actionCode_example; // String | Customization code. Supported by CXCMSACTION type.
        String catalogs = catalogs_example; // String | Filter for action catalog. Supported by CXCMSACTION type.
        String componentCatalog = componentCatalog_example; // String | Catalog of the action component. Supported by CXCMSACTION type.
        String componentId = componentId_example; // String | Id of the component used by the action. Supported by CXCMSACTION type.
        String containerId = containerId_example; // String | Id of the container used by the action. Supported by CXCMSACTION type.
        Integer currentPage = 56; // Integer | Current page number
        String customizationCode = customizationCode_example; // String | Customization code. Supported by CXCMSACTION type.
        String customizationName = customizationName_example; // String | Customization name. Supported by CXCMSACTION type.
        String customizationStatus = customizationStatus_example; // String | Comma separated customization statuses. Available statuses : ENABLED, DISABLED, DELETED. Supported by CXCMSACTION type.
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
        Boolean needsTotal = true; // Boolean | Request total count
        String pageCatalogId = pageCatalogId_example; // String | Catalog of the page action is affecting. Ignored if pageId is not provided. Supported by CXCMSACTION type.
        String pageId = pageId_example; // String | Id of the page affected by the action. Supported by CXCMSACTION type.
        Integer pageSize = 56; // Integer | Page size
        String variationCode = variationCode_example; // String | Variation code. Supported by CXCMSACTION type.
        String variationName = variationName_example; // String | Variation name. Supported by CXCMSACTION type.
        String variationStatus = variationStatus_example; // String | Comma separated variation statuses. Available statuses : ENABLED, DISABLED, DELETED. Supported by CXCMSACTION type.
        try {
            apiInstance.getActionList(catalog, catalogVersion, type, actionCode, catalogs, componentCatalog, componentId, containerId, currentPage, customizationCode, customizationName, customizationStatus, fields, needsTotal, pageCatalogId, pageId, pageSize, variationCode, variationName, variationStatus);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActionsApi#getActionList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *catalog = catalog_example; // Catalog identifier
String *catalogVersion = catalogVersion_example; // Catalog version identifier
String *type = type_example; // Type of action. CXCMSACTION requires personalizationcms extension.
String *actionCode = actionCode_example; // Customization code. Supported by CXCMSACTION type. (optional)
String *catalogs = catalogs_example; // Filter for action catalog. Supported by CXCMSACTION type. (optional)
String *componentCatalog = componentCatalog_example; // Catalog of the action component. Supported by CXCMSACTION type. (optional)
String *componentId = componentId_example; // Id of the component used by the action. Supported by CXCMSACTION type. (optional)
String *containerId = containerId_example; // Id of the container used by the action. Supported by CXCMSACTION type. (optional)
Integer *currentPage = 56; // Current page number (optional)
String *customizationCode = customizationCode_example; // Customization code. Supported by CXCMSACTION type. (optional)
String *customizationName = customizationName_example; // Customization name. Supported by CXCMSACTION type. (optional)
String *customizationStatus = customizationStatus_example; // Comma separated customization statuses. Available statuses : ENABLED, DISABLED, DELETED. Supported by CXCMSACTION type. (optional)
String *fields = fields_example; // Response configuration (list of fields, which should be returned in response) (optional)
Boolean *needsTotal = true; // Request total count (optional)
String *pageCatalogId = pageCatalogId_example; // Catalog of the page action is affecting. Ignored if pageId is not provided. Supported by CXCMSACTION type. (optional)
String *pageId = pageId_example; // Id of the page affected by the action. Supported by CXCMSACTION type. (optional)
Integer *pageSize = 56; // Page size (optional)
String *variationCode = variationCode_example; // Variation code. Supported by CXCMSACTION type. (optional)
String *variationName = variationName_example; // Variation name. Supported by CXCMSACTION type. (optional)
String *variationStatus = variationStatus_example; // Comma separated variation statuses. Available statuses : ENABLED, DISABLED, DELETED. Supported by CXCMSACTION type. (optional)

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

// Gets list of actions that fulfill search criteria with information about variation and customization
[apiInstance getActionListWith:catalog
    catalogVersion:catalogVersion
    type:type
    actionCode:actionCode
    catalogs:catalogs
    componentCatalog:componentCatalog
    componentId:componentId
    containerId:containerId
    currentPage:currentPage
    customizationCode:customizationCode
    customizationName:customizationName
    customizationStatus:customizationStatus
    fields:fields
    needsTotal:needsTotal
    pageCatalogId:pageCatalogId
    pageId:pageId
    pageSize:pageSize
    variationCode:variationCode
    variationName:variationName
    variationStatus:variationStatus
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.ActionsApi()
var catalog = catalog_example; // {{String}} Catalog identifier
var catalogVersion = catalogVersion_example; // {{String}} Catalog version identifier
var type = type_example; // {{String}} Type of action. CXCMSACTION requires personalizationcms extension.
var opts = { 
  'actionCode': actionCode_example, // {{String}} Customization code. Supported by CXCMSACTION type.
  'catalogs': catalogs_example, // {{String}} Filter for action catalog. Supported by CXCMSACTION type.
  'componentCatalog': componentCatalog_example, // {{String}} Catalog of the action component. Supported by CXCMSACTION type.
  'componentId': componentId_example, // {{String}} Id of the component used by the action. Supported by CXCMSACTION type.
  'containerId': containerId_example, // {{String}} Id of the container used by the action. Supported by CXCMSACTION type.
  'currentPage': 56, // {{Integer}} Current page number
  'customizationCode': customizationCode_example, // {{String}} Customization code. Supported by CXCMSACTION type.
  'customizationName': customizationName_example, // {{String}} Customization name. Supported by CXCMSACTION type.
  'customizationStatus': customizationStatus_example, // {{String}} Comma separated customization statuses. Available statuses : ENABLED, DISABLED, DELETED. Supported by CXCMSACTION type.
  'fields': fields_example, // {{String}} Response configuration (list of fields, which should be returned in response)
  'needsTotal': true, // {{Boolean}} Request total count
  'pageCatalogId': pageCatalogId_example, // {{String}} Catalog of the page action is affecting. Ignored if pageId is not provided. Supported by CXCMSACTION type.
  'pageId': pageId_example, // {{String}} Id of the page affected by the action. Supported by CXCMSACTION type.
  'pageSize': 56, // {{Integer}} Page size
  'variationCode': variationCode_example, // {{String}} Variation code. Supported by CXCMSACTION type.
  'variationName': variationName_example, // {{String}} Variation name. Supported by CXCMSACTION type.
  'variationStatus': variationStatus_example // {{String}} Comma separated variation statuses. Available statuses : ENABLED, DISABLED, DELETED. Supported by CXCMSACTION type.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getActionList(catalog, catalogVersion, type, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ActionsApi();
            var catalog = catalog_example;  // String | Catalog identifier
            var catalogVersion = catalogVersion_example;  // String | Catalog version identifier
            var type = type_example;  // String | Type of action. CXCMSACTION requires personalizationcms extension.
            var actionCode = actionCode_example;  // String | Customization code. Supported by CXCMSACTION type. (optional) 
            var catalogs = catalogs_example;  // String | Filter for action catalog. Supported by CXCMSACTION type. (optional) 
            var componentCatalog = componentCatalog_example;  // String | Catalog of the action component. Supported by CXCMSACTION type. (optional) 
            var componentId = componentId_example;  // String | Id of the component used by the action. Supported by CXCMSACTION type. (optional) 
            var containerId = containerId_example;  // String | Id of the container used by the action. Supported by CXCMSACTION type. (optional) 
            var currentPage = 56;  // Integer | Current page number (optional) 
            var customizationCode = customizationCode_example;  // String | Customization code. Supported by CXCMSACTION type. (optional) 
            var customizationName = customizationName_example;  // String | Customization name. Supported by CXCMSACTION type. (optional) 
            var customizationStatus = customizationStatus_example;  // String | Comma separated customization statuses. Available statuses : ENABLED, DISABLED, DELETED. Supported by CXCMSACTION type. (optional) 
            var fields = fields_example;  // String | Response configuration (list of fields, which should be returned in response) (optional) 
            var needsTotal = true;  // Boolean | Request total count (optional) 
            var pageCatalogId = pageCatalogId_example;  // String | Catalog of the page action is affecting. Ignored if pageId is not provided. Supported by CXCMSACTION type. (optional) 
            var pageId = pageId_example;  // String | Id of the page affected by the action. Supported by CXCMSACTION type. (optional) 
            var pageSize = 56;  // Integer | Page size (optional) 
            var variationCode = variationCode_example;  // String | Variation code. Supported by CXCMSACTION type. (optional) 
            var variationName = variationName_example;  // String | Variation name. Supported by CXCMSACTION type. (optional) 
            var variationStatus = variationStatus_example;  // String | Comma separated variation statuses. Available statuses : ENABLED, DISABLED, DELETED. Supported by CXCMSACTION type. (optional) 

            try
            {
                // Gets list of actions that fulfill search criteria with information about variation and customization
                apiInstance.getActionList(catalog, catalogVersion, type, actionCode, catalogs, componentCatalog, componentId, containerId, currentPage, customizationCode, customizationName, customizationStatus, fields, needsTotal, pageCatalogId, pageId, pageSize, variationCode, variationName, variationStatus);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ActionsApi.getActionList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiActionsApi();
$catalog = catalog_example; // String | Catalog identifier
$catalogVersion = catalogVersion_example; // String | Catalog version identifier
$type = type_example; // String | Type of action. CXCMSACTION requires personalizationcms extension.
$actionCode = actionCode_example; // String | Customization code. Supported by CXCMSACTION type.
$catalogs = catalogs_example; // String | Filter for action catalog. Supported by CXCMSACTION type.
$componentCatalog = componentCatalog_example; // String | Catalog of the action component. Supported by CXCMSACTION type.
$componentId = componentId_example; // String | Id of the component used by the action. Supported by CXCMSACTION type.
$containerId = containerId_example; // String | Id of the container used by the action. Supported by CXCMSACTION type.
$currentPage = 56; // Integer | Current page number
$customizationCode = customizationCode_example; // String | Customization code. Supported by CXCMSACTION type.
$customizationName = customizationName_example; // String | Customization name. Supported by CXCMSACTION type.
$customizationStatus = customizationStatus_example; // String | Comma separated customization statuses. Available statuses : ENABLED, DISABLED, DELETED. Supported by CXCMSACTION type.
$fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
$needsTotal = true; // Boolean | Request total count
$pageCatalogId = pageCatalogId_example; // String | Catalog of the page action is affecting. Ignored if pageId is not provided. Supported by CXCMSACTION type.
$pageId = pageId_example; // String | Id of the page affected by the action. Supported by CXCMSACTION type.
$pageSize = 56; // Integer | Page size
$variationCode = variationCode_example; // String | Variation code. Supported by CXCMSACTION type.
$variationName = variationName_example; // String | Variation name. Supported by CXCMSACTION type.
$variationStatus = variationStatus_example; // String | Comma separated variation statuses. Available statuses : ENABLED, DISABLED, DELETED. Supported by CXCMSACTION type.

try {
    $api_instance->getActionList($catalog, $catalogVersion, $type, $actionCode, $catalogs, $componentCatalog, $componentId, $containerId, $currentPage, $customizationCode, $customizationName, $customizationStatus, $fields, $needsTotal, $pageCatalogId, $pageId, $pageSize, $variationCode, $variationName, $variationStatus);
} catch (Exception $e) {
    echo 'Exception when calling ActionsApi->getActionList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ActionsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ActionsApi->new();
my $catalog = catalog_example; # String | Catalog identifier
my $catalogVersion = catalogVersion_example; # String | Catalog version identifier
my $type = type_example; # String | Type of action. CXCMSACTION requires personalizationcms extension.
my $actionCode = actionCode_example; # String | Customization code. Supported by CXCMSACTION type.
my $catalogs = catalogs_example; # String | Filter for action catalog. Supported by CXCMSACTION type.
my $componentCatalog = componentCatalog_example; # String | Catalog of the action component. Supported by CXCMSACTION type.
my $componentId = componentId_example; # String | Id of the component used by the action. Supported by CXCMSACTION type.
my $containerId = containerId_example; # String | Id of the container used by the action. Supported by CXCMSACTION type.
my $currentPage = 56; # Integer | Current page number
my $customizationCode = customizationCode_example; # String | Customization code. Supported by CXCMSACTION type.
my $customizationName = customizationName_example; # String | Customization name. Supported by CXCMSACTION type.
my $customizationStatus = customizationStatus_example; # String | Comma separated customization statuses. Available statuses : ENABLED, DISABLED, DELETED. Supported by CXCMSACTION type.
my $fields = fields_example; # String | Response configuration (list of fields, which should be returned in response)
my $needsTotal = true; # Boolean | Request total count
my $pageCatalogId = pageCatalogId_example; # String | Catalog of the page action is affecting. Ignored if pageId is not provided. Supported by CXCMSACTION type.
my $pageId = pageId_example; # String | Id of the page affected by the action. Supported by CXCMSACTION type.
my $pageSize = 56; # Integer | Page size
my $variationCode = variationCode_example; # String | Variation code. Supported by CXCMSACTION type.
my $variationName = variationName_example; # String | Variation name. Supported by CXCMSACTION type.
my $variationStatus = variationStatus_example; # String | Comma separated variation statuses. Available statuses : ENABLED, DISABLED, DELETED. Supported by CXCMSACTION type.

eval { 
    $api_instance->getActionList(catalog => $catalog, catalogVersion => $catalogVersion, type => $type, actionCode => $actionCode, catalogs => $catalogs, componentCatalog => $componentCatalog, componentId => $componentId, containerId => $containerId, currentPage => $currentPage, customizationCode => $customizationCode, customizationName => $customizationName, customizationStatus => $customizationStatus, fields => $fields, needsTotal => $needsTotal, pageCatalogId => $pageCatalogId, pageId => $pageId, pageSize => $pageSize, variationCode => $variationCode, variationName => $variationName, variationStatus => $variationStatus);
};
if ($@) {
    warn "Exception when calling ActionsApi->getActionList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ActionsApi()
catalog = catalog_example # String | Catalog identifier
catalogVersion = catalogVersion_example # String | Catalog version identifier
type = type_example # String | Type of action. CXCMSACTION requires personalizationcms extension.
actionCode = actionCode_example # String | Customization code. Supported by CXCMSACTION type. (optional)
catalogs = catalogs_example # String | Filter for action catalog. Supported by CXCMSACTION type. (optional)
componentCatalog = componentCatalog_example # String | Catalog of the action component. Supported by CXCMSACTION type. (optional)
componentId = componentId_example # String | Id of the component used by the action. Supported by CXCMSACTION type. (optional)
containerId = containerId_example # String | Id of the container used by the action. Supported by CXCMSACTION type. (optional)
currentPage = 56 # Integer | Current page number (optional)
customizationCode = customizationCode_example # String | Customization code. Supported by CXCMSACTION type. (optional)
customizationName = customizationName_example # String | Customization name. Supported by CXCMSACTION type. (optional)
customizationStatus = customizationStatus_example # String | Comma separated customization statuses. Available statuses : ENABLED, DISABLED, DELETED. Supported by CXCMSACTION type. (optional)
fields = fields_example # String | Response configuration (list of fields, which should be returned in response) (optional)
needsTotal = true # Boolean | Request total count (optional)
pageCatalogId = pageCatalogId_example # String | Catalog of the page action is affecting. Ignored if pageId is not provided. Supported by CXCMSACTION type. (optional)
pageId = pageId_example # String | Id of the page affected by the action. Supported by CXCMSACTION type. (optional)
pageSize = 56 # Integer | Page size (optional)
variationCode = variationCode_example # String | Variation code. Supported by CXCMSACTION type. (optional)
variationName = variationName_example # String | Variation name. Supported by CXCMSACTION type. (optional)
variationStatus = variationStatus_example # String | Comma separated variation statuses. Available statuses : ENABLED, DISABLED, DELETED. Supported by CXCMSACTION type. (optional)

try: 
    # Gets list of actions that fulfill search criteria with information about variation and customization
    api_instance.get_action_list(catalog, catalogVersion, type, actionCode=actionCode, catalogs=catalogs, componentCatalog=componentCatalog, componentId=componentId, containerId=containerId, currentPage=currentPage, customizationCode=customizationCode, customizationName=customizationName, customizationStatus=customizationStatus, fields=fields, needsTotal=needsTotal, pageCatalogId=pageCatalogId, pageId=pageId, pageSize=pageSize, variationCode=variationCode, variationName=variationName, variationStatus=variationStatus)
except ApiException as e:
    print("Exception when calling ActionsApi->getActionList: %s\n" % e)

Parameters

Path parameters
Name Description
catalog*
String
Catalog identifier
Required
catalogVersion*
String
Catalog version identifier
Required
Query parameters
Name Description
actionCode
String
Customization code. Supported by CXCMSACTION type.
catalogs
String
Filter for action catalog. Supported by CXCMSACTION type.
componentCatalog
String
Catalog of the action component. Supported by CXCMSACTION type.
componentId
String
Id of the component used by the action. Supported by CXCMSACTION type.
containerId
String
Id of the container used by the action. Supported by CXCMSACTION type.
currentPage
Integer
Current page number
customizationCode
String
Customization code. Supported by CXCMSACTION type.
customizationName
String
Customization name. Supported by CXCMSACTION type.
customizationStatus
String
Comma separated customization statuses. Available statuses : ENABLED, DISABLED, DELETED. Supported by CXCMSACTION type.
fields
String
Response configuration (list of fields, which should be returned in response)
needsTotal
Boolean
Request total count
pageCatalogId
String
Catalog of the page action is affecting. Ignored if pageId is not provided. Supported by CXCMSACTION type.
pageId
String
Id of the page affected by the action. Supported by CXCMSACTION type.
pageSize
Integer
Page size
type*
String
Type of action. CXCMSACTION requires personalizationcms extension.
Required
variationCode
String
Variation code. Supported by CXCMSACTION type.
variationName
String
Variation name. Supported by CXCMSACTION type.
variationStatus
String
Comma separated variation statuses. Available statuses : ENABLED, DISABLED, DELETED. Supported by CXCMSACTION type.

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method or catalog with given id

Status: 404 - Catalog with given id doesn't exist


getActions

Returns all actions for a given customization and variation


/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/actions

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/personalizationwebservices/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/actions?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ActionsApi;

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

public class ActionsApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ActionsApi apiInstance = new ActionsApi();
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String variationCode = variationCode_example; // String | Variation identifier
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
        try {
            apiInstance.getActions(catalog, catalogVersion, customizationCode, variationCode, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActionsApi#getActions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ActionsApi;

public class ActionsApiExample {

    public static void main(String[] args) {
        ActionsApi apiInstance = new ActionsApi();
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String variationCode = variationCode_example; // String | Variation identifier
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
        try {
            apiInstance.getActions(catalog, catalogVersion, customizationCode, variationCode, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActionsApi#getActions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *catalog = catalog_example; // Catalog identifier
String *catalogVersion = catalogVersion_example; // Catalog version identifier
String *customizationCode = customizationCode_example; // Customization identifier
String *variationCode = variationCode_example; // Variation identifier
String *fields = fields_example; // Response configuration (list of fields, which should be returned in response) (optional)

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

// Returns all actions for a given customization and variation
[apiInstance getActionsWith:catalog
    catalogVersion:catalogVersion
    customizationCode:customizationCode
    variationCode:variationCode
    fields:fields
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.ActionsApi()
var catalog = catalog_example; // {{String}} Catalog identifier
var catalogVersion = catalogVersion_example; // {{String}} Catalog version identifier
var customizationCode = customizationCode_example; // {{String}} Customization identifier
var variationCode = variationCode_example; // {{String}} Variation identifier
var opts = { 
  'fields': fields_example // {{String}} Response configuration (list of fields, which should be returned in response)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getActions(catalog, catalogVersion, customizationCode, variationCode, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ActionsApi();
            var catalog = catalog_example;  // String | Catalog identifier
            var catalogVersion = catalogVersion_example;  // String | Catalog version identifier
            var customizationCode = customizationCode_example;  // String | Customization identifier
            var variationCode = variationCode_example;  // String | Variation identifier
            var fields = fields_example;  // String | Response configuration (list of fields, which should be returned in response) (optional) 

            try
            {
                // Returns all actions for a given customization and variation
                apiInstance.getActions(catalog, catalogVersion, customizationCode, variationCode, fields);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ActionsApi.getActions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiActionsApi();
$catalog = catalog_example; // String | Catalog identifier
$catalogVersion = catalogVersion_example; // String | Catalog version identifier
$customizationCode = customizationCode_example; // String | Customization identifier
$variationCode = variationCode_example; // String | Variation identifier
$fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)

try {
    $api_instance->getActions($catalog, $catalogVersion, $customizationCode, $variationCode, $fields);
} catch (Exception $e) {
    echo 'Exception when calling ActionsApi->getActions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ActionsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ActionsApi->new();
my $catalog = catalog_example; # String | Catalog identifier
my $catalogVersion = catalogVersion_example; # String | Catalog version identifier
my $customizationCode = customizationCode_example; # String | Customization identifier
my $variationCode = variationCode_example; # String | Variation identifier
my $fields = fields_example; # String | Response configuration (list of fields, which should be returned in response)

eval { 
    $api_instance->getActions(catalog => $catalog, catalogVersion => $catalogVersion, customizationCode => $customizationCode, variationCode => $variationCode, fields => $fields);
};
if ($@) {
    warn "Exception when calling ActionsApi->getActions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ActionsApi()
catalog = catalog_example # String | Catalog identifier
catalogVersion = catalogVersion_example # String | Catalog version identifier
customizationCode = customizationCode_example # String | Customization identifier
variationCode = variationCode_example # String | Variation identifier
fields = fields_example # String | Response configuration (list of fields, which should be returned in response) (optional)

try: 
    # Returns all actions for a given customization and variation
    api_instance.get_actions(catalog, catalogVersion, customizationCode, variationCode, fields=fields)
except ApiException as e:
    print("Exception when calling ActionsApi->getActions: %s\n" % e)

Parameters

Path parameters
Name Description
catalog*
String
Catalog identifier
Required
catalogVersion*
String
Catalog version identifier
Required
customizationCode*
String
Customization identifier
Required
variationCode*
String
Variation identifier
Required
Query parameters
Name Description
fields
String
Response configuration (list of fields, which should be returned in response)

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method or catalog with given id

Status: 404 - Catalog, customization or variation with given id doesn't exist


updateAction

Updates an existing action for a given customization and variation


/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/actions/{actionCode}

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/personalizationwebservices/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/actions/{actionCode}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ActionsApi;

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

public class ActionsApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        ActionsApi apiInstance = new ActionsApi();
        Action body = ; // Action | 
        String actionCode = actionCode_example; // String | Action identifier
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String variationCode = variationCode_example; // String | Variation identifier
        try {
            apiInstance.updateAction(body, actionCode, catalog, catalogVersion, customizationCode, variationCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActionsApi#updateAction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ActionsApi;

public class ActionsApiExample {

    public static void main(String[] args) {
        ActionsApi apiInstance = new ActionsApi();
        Action body = ; // Action | 
        String actionCode = actionCode_example; // String | Action identifier
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String variationCode = variationCode_example; // String | Variation identifier
        try {
            apiInstance.updateAction(body, actionCode, catalog, catalogVersion, customizationCode, variationCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActionsApi#updateAction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Action *body = ; // 
String *actionCode = actionCode_example; // Action identifier
String *catalog = catalog_example; // Catalog identifier
String *catalogVersion = catalogVersion_example; // Catalog version identifier
String *customizationCode = customizationCode_example; // Customization identifier
String *variationCode = variationCode_example; // Variation identifier

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

// Updates an existing action for a given customization and variation
[apiInstance updateActionWith:body
    actionCode:actionCode
    catalog:catalog
    catalogVersion:catalogVersion
    customizationCode:customizationCode
    variationCode:variationCode
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.ActionsApi()
var body = ; // {{Action}} 
var actionCode = actionCode_example; // {{String}} Action identifier
var catalog = catalog_example; // {{String}} Catalog identifier
var catalogVersion = catalogVersion_example; // {{String}} Catalog version identifier
var customizationCode = customizationCode_example; // {{String}} Customization identifier
var variationCode = variationCode_example; // {{String}} Variation identifier

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ActionsApi();
            var body = new Action(); // Action | 
            var actionCode = actionCode_example;  // String | Action identifier
            var catalog = catalog_example;  // String | Catalog identifier
            var catalogVersion = catalogVersion_example;  // String | Catalog version identifier
            var customizationCode = customizationCode_example;  // String | Customization identifier
            var variationCode = variationCode_example;  // String | Variation identifier

            try
            {
                // Updates an existing action for a given customization and variation
                apiInstance.updateAction(body, actionCode, catalog, catalogVersion, customizationCode, variationCode);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ActionsApi.updateAction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiActionsApi();
$body = ; // Action | 
$actionCode = actionCode_example; // String | Action identifier
$catalog = catalog_example; // String | Catalog identifier
$catalogVersion = catalogVersion_example; // String | Catalog version identifier
$customizationCode = customizationCode_example; // String | Customization identifier
$variationCode = variationCode_example; // String | Variation identifier

try {
    $api_instance->updateAction($body, $actionCode, $catalog, $catalogVersion, $customizationCode, $variationCode);
} catch (Exception $e) {
    echo 'Exception when calling ActionsApi->updateAction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ActionsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ActionsApi->new();
my $body = WWW::SwaggerClient::Object::Action->new(); # Action | 
my $actionCode = actionCode_example; # String | Action identifier
my $catalog = catalog_example; # String | Catalog identifier
my $catalogVersion = catalogVersion_example; # String | Catalog version identifier
my $customizationCode = customizationCode_example; # String | Customization identifier
my $variationCode = variationCode_example; # String | Variation identifier

eval { 
    $api_instance->updateAction(body => $body, actionCode => $actionCode, catalog => $catalog, catalogVersion => $catalogVersion, customizationCode => $customizationCode, variationCode => $variationCode);
};
if ($@) {
    warn "Exception when calling ActionsApi->updateAction: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ActionsApi()
body =  # Action | 
actionCode = actionCode_example # String | Action identifier
catalog = catalog_example # String | Catalog identifier
catalogVersion = catalogVersion_example # String | Catalog version identifier
customizationCode = customizationCode_example # String | Customization identifier
variationCode = variationCode_example # String | Variation identifier

try: 
    # Updates an existing action for a given customization and variation
    api_instance.update_action(body, actionCode, catalog, catalogVersion, customizationCode, variationCode)
except ApiException as e:
    print("Exception when calling ActionsApi->updateAction: %s\n" % e)

Parameters

Path parameters
Name Description
actionCode*
String
Action identifier
Required
catalog*
String
Catalog identifier
Required
catalogVersion*
String
Catalog version identifier
Required
customizationCode*
String
Customization identifier
Required
variationCode*
String
Variation identifier
Required
Body parameters
Name Description
body *

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method or catalog with given id

Status: 404 - Catalog, customization, variation or action with given id doesn't exist

Status: 409 - Conflict - action code in request body and url do not match


CustomerSegmentations

createCustomerSegmentation

Creates a customer segmentation

This endpoint creates a relation between customer and segment. In default security configuration this endpoint is forbidden


/v1/customersegmentations

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/personalizationwebservices/v1/customersegmentations"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomerSegmentationsApi;

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

public class CustomerSegmentationsApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

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

public class CustomerSegmentationsApiExample {

    public static void main(String[] args) {
        CustomerSegmentationsApi apiInstance = new CustomerSegmentationsApi();
        CustomerSegmentation body = ; // CustomerSegmentation | 
        try {
            customerSegmentation result = apiInstance.createCustomerSegmentation(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerSegmentationsApi#createCustomerSegmentation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CustomerSegmentation *body = ; // 

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

// Creates a customer segmentation
[apiInstance createCustomerSegmentationWith:body
              completionHandler: ^(customerSegmentation output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.CustomerSegmentationsApi()
var body = ; // {{CustomerSegmentation}} 

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CustomerSegmentationsApi();
            var body = new CustomerSegmentation(); // CustomerSegmentation | 

            try
            {
                // Creates a customer segmentation
                customerSegmentation result = apiInstance.createCustomerSegmentation(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomerSegmentationsApi.createCustomerSegmentation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCustomerSegmentationsApi();
$body = ; // CustomerSegmentation | 

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

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

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

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

try: 
    # Creates a customer segmentation
    api_response = api_instance.create_customer_segmentation(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomerSegmentationsApi->createCustomerSegmentation: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method

Status: 404 - Customer, segment or basesite with given id doesn't exist

Status: 409 - Conflict - relation between customer and segment already exists


deleteCustomerSegmentation

Deletes a customer segmentation

This endpoint deletes a relation between a customer and segment. In default security configuration this endpoint is forbidden


/v1/customersegmentations/{segmentationId}

Usage and SDK Samples

curl -X DELETE\
\
\
"http://localhost:9001/personalizationwebservices/v1/customersegmentations/{segmentationId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomerSegmentationsApi;

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

public class CustomerSegmentationsApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        CustomerSegmentationsApi apiInstance = new CustomerSegmentationsApi();
        String segmentationId = segmentationId_example; // String | 
        try {
            apiInstance.deleteCustomerSegmentation(segmentationId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerSegmentationsApi#deleteCustomerSegmentation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomerSegmentationsApi;

public class CustomerSegmentationsApiExample {

    public static void main(String[] args) {
        CustomerSegmentationsApi apiInstance = new CustomerSegmentationsApi();
        String segmentationId = segmentationId_example; // String | 
        try {
            apiInstance.deleteCustomerSegmentation(segmentationId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerSegmentationsApi#deleteCustomerSegmentation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *segmentationId = segmentationId_example; // 

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

// Deletes a customer segmentation
[apiInstance deleteCustomerSegmentationWith:segmentationId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.CustomerSegmentationsApi()
var segmentationId = segmentationId_example; // {{String}} 

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CustomerSegmentationsApi();
            var segmentationId = segmentationId_example;  // String | 

            try
            {
                // Deletes a customer segmentation
                apiInstance.deleteCustomerSegmentation(segmentationId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomerSegmentationsApi.deleteCustomerSegmentation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCustomerSegmentationsApi();
$segmentationId = segmentationId_example; // String | 

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CustomerSegmentationsApi->new();
my $segmentationId = segmentationId_example; # String | 

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CustomerSegmentationsApi()
segmentationId = segmentationId_example # String | 

try: 
    # Deletes a customer segmentation
    api_instance.delete_customer_segmentation(segmentationId)
except ApiException as e:
    print("Exception when calling CustomerSegmentationsApi->deleteCustomerSegmentation: %s\n" % e)

Parameters

Path parameters
Name Description
segmentationId*
String
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request e.g. incorrect identifier

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method

Status: 404 - Relation between customer and segment doesn't exist


getCustomerSegmentationById

Returns customer segmentations

This endpoint returns list segmententations matching customer id and segment id passed as parameters. In default security configuration this endpoint is forbidden


/v1/customersegmentations

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/personalizationwebservices/v1/customersegmentations?baseSite=¤tPage=&customerId=&fields=&needsTotal=&pageSize=&segmentId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomerSegmentationsApi;

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

public class CustomerSegmentationsApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        CustomerSegmentationsApi apiInstance = new CustomerSegmentationsApi();
        String baseSite = baseSite_example; // String | Basesite identifier
        Integer currentPage = 56; // Integer | Current page number
        String customerId = customerId_example; // String | Customer identifier. At least one of parameters is required : customerId, segmentId 
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
        Boolean needsTotal = true; // Boolean | Request total count
        Integer pageSize = 56; // Integer | Page size
        String segmentId = segmentId_example; // String | Segment identifier. At least one of parameters is required : customerId, segmentId
        try {
            apiInstance.getCustomerSegmentationById(baseSite, currentPage, customerId, fields, needsTotal, pageSize, segmentId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerSegmentationsApi#getCustomerSegmentationById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomerSegmentationsApi;

public class CustomerSegmentationsApiExample {

    public static void main(String[] args) {
        CustomerSegmentationsApi apiInstance = new CustomerSegmentationsApi();
        String baseSite = baseSite_example; // String | Basesite identifier
        Integer currentPage = 56; // Integer | Current page number
        String customerId = customerId_example; // String | Customer identifier. At least one of parameters is required : customerId, segmentId 
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
        Boolean needsTotal = true; // Boolean | Request total count
        Integer pageSize = 56; // Integer | Page size
        String segmentId = segmentId_example; // String | Segment identifier. At least one of parameters is required : customerId, segmentId
        try {
            apiInstance.getCustomerSegmentationById(baseSite, currentPage, customerId, fields, needsTotal, pageSize, segmentId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerSegmentationsApi#getCustomerSegmentationById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSite = baseSite_example; // Basesite identifier (optional)
Integer *currentPage = 56; // Current page number (optional)
String *customerId = customerId_example; // Customer identifier. At least one of parameters is required : customerId, segmentId  (optional)
String *fields = fields_example; // Response configuration (list of fields, which should be returned in response) (optional)
Boolean *needsTotal = true; // Request total count (optional)
Integer *pageSize = 56; // Page size (optional)
String *segmentId = segmentId_example; // Segment identifier. At least one of parameters is required : customerId, segmentId (optional)

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

// Returns customer segmentations
[apiInstance getCustomerSegmentationByIdWith:baseSite
    currentPage:currentPage
    customerId:customerId
    fields:fields
    needsTotal:needsTotal
    pageSize:pageSize
    segmentId:segmentId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.CustomerSegmentationsApi()
var opts = { 
  'baseSite': baseSite_example, // {{String}} Basesite identifier
  'currentPage': 56, // {{Integer}} Current page number
  'customerId': customerId_example, // {{String}} Customer identifier. At least one of parameters is required : customerId, segmentId 
  'fields': fields_example, // {{String}} Response configuration (list of fields, which should be returned in response)
  'needsTotal': true, // {{Boolean}} Request total count
  'pageSize': 56, // {{Integer}} Page size
  'segmentId': segmentId_example // {{String}} Segment identifier. At least one of parameters is required : customerId, segmentId
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getCustomerSegmentationById(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CustomerSegmentationsApi();
            var baseSite = baseSite_example;  // String | Basesite identifier (optional) 
            var currentPage = 56;  // Integer | Current page number (optional) 
            var customerId = customerId_example;  // String | Customer identifier. At least one of parameters is required : customerId, segmentId  (optional) 
            var fields = fields_example;  // String | Response configuration (list of fields, which should be returned in response) (optional) 
            var needsTotal = true;  // Boolean | Request total count (optional) 
            var pageSize = 56;  // Integer | Page size (optional) 
            var segmentId = segmentId_example;  // String | Segment identifier. At least one of parameters is required : customerId, segmentId (optional) 

            try
            {
                // Returns customer segmentations
                apiInstance.getCustomerSegmentationById(baseSite, currentPage, customerId, fields, needsTotal, pageSize, segmentId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomerSegmentationsApi.getCustomerSegmentationById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCustomerSegmentationsApi();
$baseSite = baseSite_example; // String | Basesite identifier
$currentPage = 56; // Integer | Current page number
$customerId = customerId_example; // String | Customer identifier. At least one of parameters is required : customerId, segmentId 
$fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
$needsTotal = true; // Boolean | Request total count
$pageSize = 56; // Integer | Page size
$segmentId = segmentId_example; // String | Segment identifier. At least one of parameters is required : customerId, segmentId

try {
    $api_instance->getCustomerSegmentationById($baseSite, $currentPage, $customerId, $fields, $needsTotal, $pageSize, $segmentId);
} catch (Exception $e) {
    echo 'Exception when calling CustomerSegmentationsApi->getCustomerSegmentationById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomerSegmentationsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CustomerSegmentationsApi->new();
my $baseSite = baseSite_example; # String | Basesite identifier
my $currentPage = 56; # Integer | Current page number
my $customerId = customerId_example; # String | Customer identifier. At least one of parameters is required : customerId, segmentId 
my $fields = fields_example; # String | Response configuration (list of fields, which should be returned in response)
my $needsTotal = true; # Boolean | Request total count
my $pageSize = 56; # Integer | Page size
my $segmentId = segmentId_example; # String | Segment identifier. At least one of parameters is required : customerId, segmentId

eval { 
    $api_instance->getCustomerSegmentationById(baseSite => $baseSite, currentPage => $currentPage, customerId => $customerId, fields => $fields, needsTotal => $needsTotal, pageSize => $pageSize, segmentId => $segmentId);
};
if ($@) {
    warn "Exception when calling CustomerSegmentationsApi->getCustomerSegmentationById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CustomerSegmentationsApi()
baseSite = baseSite_example # String | Basesite identifier (optional)
currentPage = 56 # Integer | Current page number (optional)
customerId = customerId_example # String | Customer identifier. At least one of parameters is required : customerId, segmentId  (optional)
fields = fields_example # String | Response configuration (list of fields, which should be returned in response) (optional)
needsTotal = true # Boolean | Request total count (optional)
pageSize = 56 # Integer | Page size (optional)
segmentId = segmentId_example # String | Segment identifier. At least one of parameters is required : customerId, segmentId (optional)

try: 
    # Returns customer segmentations
    api_instance.get_customer_segmentation_by_id(baseSite=baseSite, currentPage=currentPage, customerId=customerId, fields=fields, needsTotal=needsTotal, pageSize=pageSize, segmentId=segmentId)
except ApiException as e:
    print("Exception when calling CustomerSegmentationsApi->getCustomerSegmentationById: %s\n" % e)

Parameters

Query parameters
Name Description
baseSite
String
Basesite identifier
currentPage
Integer
Current page number
customerId
String
Customer identifier. At least one of parameters is required : customerId, segmentId
fields
String
Response configuration (list of fields, which should be returned in response)
needsTotal
Boolean
Request total count
pageSize
Integer
Page size
segmentId
String
Segment identifier. At least one of parameters is required : customerId, segmentId

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method

Status: 404 - Not Found


getCustomerSegmentationRelation

Get a customer segmentation

This endpoint returns a relation between a customer and a segment. In default security configuration this endpoint is forbidden


/v1/customersegmentations/{segmentationId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/personalizationwebservices/v1/customersegmentations/{segmentationId}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomerSegmentationsApi;

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

public class CustomerSegmentationsApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        CustomerSegmentationsApi apiInstance = new CustomerSegmentationsApi();
        String segmentationId = segmentationId_example; // String | Relation identifier
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
        try {
            apiInstance.getCustomerSegmentationRelation(segmentationId, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerSegmentationsApi#getCustomerSegmentationRelation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomerSegmentationsApi;

public class CustomerSegmentationsApiExample {

    public static void main(String[] args) {
        CustomerSegmentationsApi apiInstance = new CustomerSegmentationsApi();
        String segmentationId = segmentationId_example; // String | Relation identifier
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
        try {
            apiInstance.getCustomerSegmentationRelation(segmentationId, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerSegmentationsApi#getCustomerSegmentationRelation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *segmentationId = segmentationId_example; // Relation identifier
String *fields = fields_example; // Response configuration (list of fields, which should be returned in response) (optional)

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

// Get a customer segmentation
[apiInstance getCustomerSegmentationRelationWith:segmentationId
    fields:fields
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.CustomerSegmentationsApi()
var segmentationId = segmentationId_example; // {{String}} Relation identifier
var opts = { 
  'fields': fields_example // {{String}} Response configuration (list of fields, which should be returned in response)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getCustomerSegmentationRelation(segmentationId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CustomerSegmentationsApi();
            var segmentationId = segmentationId_example;  // String | Relation identifier
            var fields = fields_example;  // String | Response configuration (list of fields, which should be returned in response) (optional) 

            try
            {
                // Get a customer segmentation
                apiInstance.getCustomerSegmentationRelation(segmentationId, fields);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomerSegmentationsApi.getCustomerSegmentationRelation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCustomerSegmentationsApi();
$segmentationId = segmentationId_example; // String | Relation identifier
$fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CustomerSegmentationsApi->new();
my $segmentationId = segmentationId_example; # String | Relation identifier
my $fields = fields_example; # String | Response configuration (list of fields, which should be returned in response)

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CustomerSegmentationsApi()
segmentationId = segmentationId_example # String | Relation identifier
fields = fields_example # String | Response configuration (list of fields, which should be returned in response) (optional)

try: 
    # Get a customer segmentation
    api_instance.get_customer_segmentation_relation(segmentationId, fields=fields)
except ApiException as e:
    print("Exception when calling CustomerSegmentationsApi->getCustomerSegmentationRelation: %s\n" % e)

Parameters

Path parameters
Name Description
segmentationId*
String
Relation identifier
Required
Query parameters
Name Description
fields
String
Response configuration (list of fields, which should be returned in response)

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method

Status: 404 - Relation between customer and segment doesn't exist


updateCustomerSegmentation

Updates a customer segmentation

This endpoint updates a relation between a customer and segment. In default security configuration this endpoint is forbidden


/v1/customersegmentations/{segmentationId}

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/personalizationwebservices/v1/customersegmentations/{segmentationId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomerSegmentationsApi;

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

public class CustomerSegmentationsApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        CustomerSegmentationsApi apiInstance = new CustomerSegmentationsApi();
        CustomerSegmentation body = ; // CustomerSegmentation | 
        String segmentationId = segmentationId_example; // String | Relation identifier
        try {
            apiInstance.updateCustomerSegmentation(body, segmentationId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerSegmentationsApi#updateCustomerSegmentation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomerSegmentationsApi;

public class CustomerSegmentationsApiExample {

    public static void main(String[] args) {
        CustomerSegmentationsApi apiInstance = new CustomerSegmentationsApi();
        CustomerSegmentation body = ; // CustomerSegmentation | 
        String segmentationId = segmentationId_example; // String | Relation identifier
        try {
            apiInstance.updateCustomerSegmentation(body, segmentationId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerSegmentationsApi#updateCustomerSegmentation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
CustomerSegmentation *body = ; // 
String *segmentationId = segmentationId_example; // Relation identifier

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

// Updates a customer segmentation
[apiInstance updateCustomerSegmentationWith:body
    segmentationId:segmentationId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.CustomerSegmentationsApi()
var body = ; // {{CustomerSegmentation}} 
var segmentationId = segmentationId_example; // {{String}} Relation identifier

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CustomerSegmentationsApi();
            var body = new CustomerSegmentation(); // CustomerSegmentation | 
            var segmentationId = segmentationId_example;  // String | Relation identifier

            try
            {
                // Updates a customer segmentation
                apiInstance.updateCustomerSegmentation(body, segmentationId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomerSegmentationsApi.updateCustomerSegmentation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCustomerSegmentationsApi();
$body = ; // CustomerSegmentation | 
$segmentationId = segmentationId_example; // String | Relation identifier

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CustomerSegmentationsApi->new();
my $body = WWW::SwaggerClient::Object::CustomerSegmentation->new(); # CustomerSegmentation | 
my $segmentationId = segmentationId_example; # String | Relation identifier

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CustomerSegmentationsApi()
body =  # CustomerSegmentation | 
segmentationId = segmentationId_example # String | Relation identifier

try: 
    # Updates a customer segmentation
    api_instance.update_customer_segmentation(body, segmentationId)
except ApiException as e:
    print("Exception when calling CustomerSegmentationsApi->updateCustomerSegmentation: %s\n" % e)

Parameters

Path parameters
Name Description
segmentationId*
String
Relation identifier
Required
Body parameters
Name Description
body *

Responses

Status: 400 - Bad Request e.g. incorrect identifier

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method

Status: 404 - Relation between customer and segment doesn't exist

Status: 409 - Conflict - CustomerSegmentation code in request body and url do not match.


CustomizationPackages

createCustomizationWithRelatedObjects

Creates customization with related objects like variations and triggers


/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizationpackages

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/personalizationwebservices/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizationpackages"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomizationPackagesApi;

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

public class CustomizationPackagesApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        CustomizationPackagesApi apiInstance = new CustomizationPackagesApi();
        Customization body = ; // Customization | 
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        try {
            customization result = apiInstance.createCustomizationWithRelatedObjects(body, catalog, catalogVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomizationPackagesApi#createCustomizationWithRelatedObjects");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomizationPackagesApi;

public class CustomizationPackagesApiExample {

    public static void main(String[] args) {
        CustomizationPackagesApi apiInstance = new CustomizationPackagesApi();
        Customization body = ; // Customization | 
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        try {
            customization result = apiInstance.createCustomizationWithRelatedObjects(body, catalog, catalogVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomizationPackagesApi#createCustomizationWithRelatedObjects");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Customization *body = ; // 
String *catalog = catalog_example; // Catalog identifier
String *catalogVersion = catalogVersion_example; // Catalog version identifier

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

// Creates customization with related objects like variations and triggers
[apiInstance createCustomizationWithRelatedObjectsWith:body
    catalog:catalog
    catalogVersion:catalogVersion
              completionHandler: ^(customization output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.CustomizationPackagesApi()
var body = ; // {{Customization}} 
var catalog = catalog_example; // {{String}} Catalog identifier
var catalogVersion = catalogVersion_example; // {{String}} Catalog version identifier

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CustomizationPackagesApi();
            var body = new Customization(); // Customization | 
            var catalog = catalog_example;  // String | Catalog identifier
            var catalogVersion = catalogVersion_example;  // String | Catalog version identifier

            try
            {
                // Creates customization with related objects like variations and triggers
                customization result = apiInstance.createCustomizationWithRelatedObjects(body, catalog, catalogVersion);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomizationPackagesApi.createCustomizationWithRelatedObjects: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCustomizationPackagesApi();
$body = ; // Customization | 
$catalog = catalog_example; // String | Catalog identifier
$catalogVersion = catalogVersion_example; // String | Catalog version identifier

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CustomizationPackagesApi->new();
my $body = WWW::SwaggerClient::Object::Customization->new(); # Customization | 
my $catalog = catalog_example; # String | Catalog identifier
my $catalogVersion = catalogVersion_example; # String | Catalog version identifier

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CustomizationPackagesApi()
body =  # Customization | 
catalog = catalog_example # String | Catalog identifier
catalogVersion = catalogVersion_example # String | Catalog version identifier

try: 
    # Creates customization with related objects like variations and triggers
    api_response = api_instance.create_customization_with_related_objects(body, catalog, catalogVersion)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomizationPackagesApi->createCustomizationWithRelatedObjects: %s\n" % e)

Parameters

Path parameters
Name Description
catalog*
String
Catalog identifier
Required
catalogVersion*
String
Catalog version identifier
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method or catalog with given id

Status: 404 - Catalog with given id doesn't exist

Status: 409 - Conflict - customization with given code already exists


updateCustomizationWithRelatedObjects

Updates customization and related objects


/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizationpackages/{customizationCode}

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/personalizationwebservices/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizationpackages/{customizationCode}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomizationPackagesApi;

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

public class CustomizationPackagesApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        CustomizationPackagesApi apiInstance = new CustomizationPackagesApi();
        Customization body = ; // Customization | 
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        try {
            apiInstance.updateCustomizationWithRelatedObjects(body, catalog, catalogVersion, customizationCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomizationPackagesApi#updateCustomizationWithRelatedObjects");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomizationPackagesApi;

public class CustomizationPackagesApiExample {

    public static void main(String[] args) {
        CustomizationPackagesApi apiInstance = new CustomizationPackagesApi();
        Customization body = ; // Customization | 
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        try {
            apiInstance.updateCustomizationWithRelatedObjects(body, catalog, catalogVersion, customizationCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomizationPackagesApi#updateCustomizationWithRelatedObjects");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Customization *body = ; // 
String *catalog = catalog_example; // Catalog identifier
String *catalogVersion = catalogVersion_example; // Catalog version identifier
String *customizationCode = customizationCode_example; // Customization identifier

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

// Updates customization and related objects
[apiInstance updateCustomizationWithRelatedObjectsWith:body
    catalog:catalog
    catalogVersion:catalogVersion
    customizationCode:customizationCode
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.CustomizationPackagesApi()
var body = ; // {{Customization}} 
var catalog = catalog_example; // {{String}} Catalog identifier
var catalogVersion = catalogVersion_example; // {{String}} Catalog version identifier
var customizationCode = customizationCode_example; // {{String}} Customization identifier

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CustomizationPackagesApi();
            var body = new Customization(); // Customization | 
            var catalog = catalog_example;  // String | Catalog identifier
            var catalogVersion = catalogVersion_example;  // String | Catalog version identifier
            var customizationCode = customizationCode_example;  // String | Customization identifier

            try
            {
                // Updates customization and related objects
                apiInstance.updateCustomizationWithRelatedObjects(body, catalog, catalogVersion, customizationCode);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomizationPackagesApi.updateCustomizationWithRelatedObjects: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCustomizationPackagesApi();
$body = ; // Customization | 
$catalog = catalog_example; // String | Catalog identifier
$catalogVersion = catalogVersion_example; // String | Catalog version identifier
$customizationCode = customizationCode_example; // String | Customization identifier

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CustomizationPackagesApi->new();
my $body = WWW::SwaggerClient::Object::Customization->new(); # Customization | 
my $catalog = catalog_example; # String | Catalog identifier
my $catalogVersion = catalogVersion_example; # String | Catalog version identifier
my $customizationCode = customizationCode_example; # String | Customization identifier

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CustomizationPackagesApi()
body =  # Customization | 
catalog = catalog_example # String | Catalog identifier
catalogVersion = catalogVersion_example # String | Catalog version identifier
customizationCode = customizationCode_example # String | Customization identifier

try: 
    # Updates customization and related objects
    api_instance.update_customization_with_related_objects(body, catalog, catalogVersion, customizationCode)
except ApiException as e:
    print("Exception when calling CustomizationPackagesApi->updateCustomizationWithRelatedObjects: %s\n" % e)

Parameters

Path parameters
Name Description
catalog*
String
Catalog identifier
Required
catalogVersion*
String
Catalog version identifier
Required
customizationCode*
String
Customization identifier
Required
Body parameters
Name Description
body *

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method or catalog with given id

Status: 404 - Catalog with given id doesn't exist

Status: 409 - Conflict - customization code in request body and url do not match


Customizations

createCustomization

Creates a customization


/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/personalizationwebservices/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomizationsApi;

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

public class CustomizationsApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        CustomizationsApi apiInstance = new CustomizationsApi();
        Customization body = ; // Customization | 
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        try {
            customization result = apiInstance.createCustomization(body, catalog, catalogVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomizationsApi#createCustomization");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomizationsApi;

public class CustomizationsApiExample {

    public static void main(String[] args) {
        CustomizationsApi apiInstance = new CustomizationsApi();
        Customization body = ; // Customization | 
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        try {
            customization result = apiInstance.createCustomization(body, catalog, catalogVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomizationsApi#createCustomization");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Customization *body = ; // 
String *catalog = catalog_example; // Catalog identifier
String *catalogVersion = catalogVersion_example; // Catalog version identifier

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

// Creates a customization
[apiInstance createCustomizationWith:body
    catalog:catalog
    catalogVersion:catalogVersion
              completionHandler: ^(customization output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.CustomizationsApi()
var body = ; // {{Customization}} 
var catalog = catalog_example; // {{String}} Catalog identifier
var catalogVersion = catalogVersion_example; // {{String}} Catalog version identifier

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CustomizationsApi();
            var body = new Customization(); // Customization | 
            var catalog = catalog_example;  // String | Catalog identifier
            var catalogVersion = catalogVersion_example;  // String | Catalog version identifier

            try
            {
                // Creates a customization
                customization result = apiInstance.createCustomization(body, catalog, catalogVersion);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomizationsApi.createCustomization: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCustomizationsApi();
$body = ; // Customization | 
$catalog = catalog_example; // String | Catalog identifier
$catalogVersion = catalogVersion_example; // String | Catalog version identifier

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CustomizationsApi->new();
my $body = WWW::SwaggerClient::Object::Customization->new(); # Customization | 
my $catalog = catalog_example; # String | Catalog identifier
my $catalogVersion = catalogVersion_example; # String | Catalog version identifier

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CustomizationsApi()
body =  # Customization | 
catalog = catalog_example # String | Catalog identifier
catalogVersion = catalogVersion_example # String | Catalog version identifier

try: 
    # Creates a customization
    api_response = api_instance.create_customization(body, catalog, catalogVersion)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomizationsApi->createCustomization: %s\n" % e)

Parameters

Path parameters
Name Description
catalog*
String
Catalog identifier
Required
catalogVersion*
String
Catalog version identifier
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method or catalog with given id

Status: 404 - Catalog with given id doesn't exist

Status: 409 - Conflict - customization with given code already exists


deleteCustomization

Deletes a customization


/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}

Usage and SDK Samples

curl -X DELETE\
\
\
"http://localhost:9001/personalizationwebservices/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomizationsApi;

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

public class CustomizationsApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        CustomizationsApi apiInstance = new CustomizationsApi();
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        try {
            apiInstance.deleteCustomization(catalog, catalogVersion, customizationCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomizationsApi#deleteCustomization");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomizationsApi;

public class CustomizationsApiExample {

    public static void main(String[] args) {
        CustomizationsApi apiInstance = new CustomizationsApi();
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        try {
            apiInstance.deleteCustomization(catalog, catalogVersion, customizationCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomizationsApi#deleteCustomization");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *catalog = catalog_example; // Catalog identifier
String *catalogVersion = catalogVersion_example; // Catalog version identifier
String *customizationCode = customizationCode_example; // Customization identifier

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

// Deletes a customization
[apiInstance deleteCustomizationWith:catalog
    catalogVersion:catalogVersion
    customizationCode:customizationCode
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.CustomizationsApi()
var catalog = catalog_example; // {{String}} Catalog identifier
var catalogVersion = catalogVersion_example; // {{String}} Catalog version identifier
var customizationCode = customizationCode_example; // {{String}} Customization identifier

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CustomizationsApi();
            var catalog = catalog_example;  // String | Catalog identifier
            var catalogVersion = catalogVersion_example;  // String | Catalog version identifier
            var customizationCode = customizationCode_example;  // String | Customization identifier

            try
            {
                // Deletes a customization
                apiInstance.deleteCustomization(catalog, catalogVersion, customizationCode);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomizationsApi.deleteCustomization: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCustomizationsApi();
$catalog = catalog_example; // String | Catalog identifier
$catalogVersion = catalogVersion_example; // String | Catalog version identifier
$customizationCode = customizationCode_example; // String | Customization identifier

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CustomizationsApi->new();
my $catalog = catalog_example; # String | Catalog identifier
my $catalogVersion = catalogVersion_example; # String | Catalog version identifier
my $customizationCode = customizationCode_example; # String | Customization identifier

eval { 
    $api_instance->deleteCustomization(catalog => $catalog, catalogVersion => $catalogVersion, customizationCode => $customizationCode);
};
if ($@) {
    warn "Exception when calling CustomizationsApi->deleteCustomization: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CustomizationsApi()
catalog = catalog_example # String | Catalog identifier
catalogVersion = catalogVersion_example # String | Catalog version identifier
customizationCode = customizationCode_example # String | Customization identifier

try: 
    # Deletes a customization
    api_instance.delete_customization(catalog, catalogVersion, customizationCode)
except ApiException as e:
    print("Exception when calling CustomizationsApi->deleteCustomization: %s\n" % e)

Parameters

Path parameters
Name Description
catalog*
String
Catalog identifier
Required
catalogVersion*
String
Catalog version identifier
Required
customizationCode*
String
Customization identifier
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method or catalog with given id

Status: 404 - Catalog with given id doesn't exist


getCustomization

Get a customization


/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/personalizationwebservices/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomizationsApi;

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

public class CustomizationsApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        CustomizationsApi apiInstance = new CustomizationsApi();
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
        try {
            apiInstance.getCustomization(catalog, catalogVersion, customizationCode, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomizationsApi#getCustomization");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomizationsApi;

public class CustomizationsApiExample {

    public static void main(String[] args) {
        CustomizationsApi apiInstance = new CustomizationsApi();
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
        try {
            apiInstance.getCustomization(catalog, catalogVersion, customizationCode, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomizationsApi#getCustomization");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *catalog = catalog_example; // Catalog identifier
String *catalogVersion = catalogVersion_example; // Catalog version identifier
String *customizationCode = customizationCode_example; // Customization identifier
String *fields = fields_example; // Response configuration (list of fields, which should be returned in response) (optional)

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

// Get a customization
[apiInstance getCustomizationWith:catalog
    catalogVersion:catalogVersion
    customizationCode:customizationCode
    fields:fields
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.CustomizationsApi()
var catalog = catalog_example; // {{String}} Catalog identifier
var catalogVersion = catalogVersion_example; // {{String}} Catalog version identifier
var customizationCode = customizationCode_example; // {{String}} Customization identifier
var opts = { 
  'fields': fields_example // {{String}} Response configuration (list of fields, which should be returned in response)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getCustomization(catalog, catalogVersion, customizationCode, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CustomizationsApi();
            var catalog = catalog_example;  // String | Catalog identifier
            var catalogVersion = catalogVersion_example;  // String | Catalog version identifier
            var customizationCode = customizationCode_example;  // String | Customization identifier
            var fields = fields_example;  // String | Response configuration (list of fields, which should be returned in response) (optional) 

            try
            {
                // Get a customization
                apiInstance.getCustomization(catalog, catalogVersion, customizationCode, fields);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomizationsApi.getCustomization: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCustomizationsApi();
$catalog = catalog_example; // String | Catalog identifier
$catalogVersion = catalogVersion_example; // String | Catalog version identifier
$customizationCode = customizationCode_example; // String | Customization identifier
$fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)

try {
    $api_instance->getCustomization($catalog, $catalogVersion, $customizationCode, $fields);
} catch (Exception $e) {
    echo 'Exception when calling CustomizationsApi->getCustomization: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomizationsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CustomizationsApi->new();
my $catalog = catalog_example; # String | Catalog identifier
my $catalogVersion = catalogVersion_example; # String | Catalog version identifier
my $customizationCode = customizationCode_example; # String | Customization identifier
my $fields = fields_example; # String | Response configuration (list of fields, which should be returned in response)

eval { 
    $api_instance->getCustomization(catalog => $catalog, catalogVersion => $catalogVersion, customizationCode => $customizationCode, fields => $fields);
};
if ($@) {
    warn "Exception when calling CustomizationsApi->getCustomization: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CustomizationsApi()
catalog = catalog_example # String | Catalog identifier
catalogVersion = catalogVersion_example # String | Catalog version identifier
customizationCode = customizationCode_example # String | Customization identifier
fields = fields_example # String | Response configuration (list of fields, which should be returned in response) (optional)

try: 
    # Get a customization
    api_instance.get_customization(catalog, catalogVersion, customizationCode, fields=fields)
except ApiException as e:
    print("Exception when calling CustomizationsApi->getCustomization: %s\n" % e)

Parameters

Path parameters
Name Description
catalog*
String
Catalog identifier
Required
catalogVersion*
String
Catalog version identifier
Required
customizationCode*
String
Customization identifier
Required
Query parameters
Name Description
fields
String
Response configuration (list of fields, which should be returned in response)

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method or catalog with given id

Status: 404 - Catalog with given id doesn't exist


getCustomizations

Returns all customizations


/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/personalizationwebservices/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations?catalogs=&code=¤tPage=&fields=&name=&needsTotal=&negatePageId=&pageCatalogId=&pageId=&pageSize=&statuses="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomizationsApi;

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

public class CustomizationsApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        CustomizationsApi apiInstance = new CustomizationsApi();
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String catalogs = catalogs_example; // String | Filter for customization catalog. Requires personalizationcms extension.
        String code = code_example; // String | Filter for customization identifier. This filter don't work together with other filters (pageId, statuses, name)
        Integer currentPage = 56; // Integer | Current page number
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
        String name = name_example; // String | Filter for customization name. This require also 'statuses' parameter to be set
        Boolean needsTotal = true; // Boolean | Request total count
        Boolean negatePageId = true; // Boolean | Flag to return customizations not related to page with 'pageId'. Requires personalizationcms extension.
        String pageCatalogId = pageCatalogId_example; // String | Page catalog identifier. Requires personalizationcms extension.
        String pageId = pageId_example; // String | Page identifier. This require also 'statuses' parameter to be set. Requires personalizationcms extension.
        Integer pageSize = 56; // Integer | Page size
        String statuses = statuses_example; // String | Comma separated customization statuses. Available statuses : ENABLED, DISABLED, DELETED
        try {
            apiInstance.getCustomizations(catalog, catalogVersion, catalogs, code, currentPage, fields, name, needsTotal, negatePageId, pageCatalogId, pageId, pageSize, statuses);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomizationsApi#getCustomizations");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomizationsApi;

public class CustomizationsApiExample {

    public static void main(String[] args) {
        CustomizationsApi apiInstance = new CustomizationsApi();
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String catalogs = catalogs_example; // String | Filter for customization catalog. Requires personalizationcms extension.
        String code = code_example; // String | Filter for customization identifier. This filter don't work together with other filters (pageId, statuses, name)
        Integer currentPage = 56; // Integer | Current page number
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
        String name = name_example; // String | Filter for customization name. This require also 'statuses' parameter to be set
        Boolean needsTotal = true; // Boolean | Request total count
        Boolean negatePageId = true; // Boolean | Flag to return customizations not related to page with 'pageId'. Requires personalizationcms extension.
        String pageCatalogId = pageCatalogId_example; // String | Page catalog identifier. Requires personalizationcms extension.
        String pageId = pageId_example; // String | Page identifier. This require also 'statuses' parameter to be set. Requires personalizationcms extension.
        Integer pageSize = 56; // Integer | Page size
        String statuses = statuses_example; // String | Comma separated customization statuses. Available statuses : ENABLED, DISABLED, DELETED
        try {
            apiInstance.getCustomizations(catalog, catalogVersion, catalogs, code, currentPage, fields, name, needsTotal, negatePageId, pageCatalogId, pageId, pageSize, statuses);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomizationsApi#getCustomizations");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *catalog = catalog_example; // Catalog identifier
String *catalogVersion = catalogVersion_example; // Catalog version identifier
String *catalogs = catalogs_example; // Filter for customization catalog. Requires personalizationcms extension. (optional)
String *code = code_example; // Filter for customization identifier. This filter don't work together with other filters (pageId, statuses, name) (optional)
Integer *currentPage = 56; // Current page number (optional)
String *fields = fields_example; // Response configuration (list of fields, which should be returned in response) (optional)
String *name = name_example; // Filter for customization name. This require also 'statuses' parameter to be set (optional)
Boolean *needsTotal = true; // Request total count (optional)
Boolean *negatePageId = true; // Flag to return customizations not related to page with 'pageId'. Requires personalizationcms extension. (optional)
String *pageCatalogId = pageCatalogId_example; // Page catalog identifier. Requires personalizationcms extension. (optional)
String *pageId = pageId_example; // Page identifier. This require also 'statuses' parameter to be set. Requires personalizationcms extension. (optional)
Integer *pageSize = 56; // Page size (optional)
String *statuses = statuses_example; // Comma separated customization statuses. Available statuses : ENABLED, DISABLED, DELETED (optional)

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

// Returns all customizations
[apiInstance getCustomizationsWith:catalog
    catalogVersion:catalogVersion
    catalogs:catalogs
    code:code
    currentPage:currentPage
    fields:fields
    name:name
    needsTotal:needsTotal
    negatePageId:negatePageId
    pageCatalogId:pageCatalogId
    pageId:pageId
    pageSize:pageSize
    statuses:statuses
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.CustomizationsApi()
var catalog = catalog_example; // {{String}} Catalog identifier
var catalogVersion = catalogVersion_example; // {{String}} Catalog version identifier
var opts = { 
  'catalogs': catalogs_example, // {{String}} Filter for customization catalog. Requires personalizationcms extension.
  'code': code_example, // {{String}} Filter for customization identifier. This filter don't work together with other filters (pageId, statuses, name)
  'currentPage': 56, // {{Integer}} Current page number
  'fields': fields_example, // {{String}} Response configuration (list of fields, which should be returned in response)
  'name': name_example, // {{String}} Filter for customization name. This require also 'statuses' parameter to be set
  'needsTotal': true, // {{Boolean}} Request total count
  'negatePageId': true, // {{Boolean}} Flag to return customizations not related to page with 'pageId'. Requires personalizationcms extension.
  'pageCatalogId': pageCatalogId_example, // {{String}} Page catalog identifier. Requires personalizationcms extension.
  'pageId': pageId_example, // {{String}} Page identifier. This require also 'statuses' parameter to be set. Requires personalizationcms extension.
  'pageSize': 56, // {{Integer}} Page size
  'statuses': statuses_example // {{String}} Comma separated customization statuses. Available statuses : ENABLED, DISABLED, DELETED
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getCustomizations(catalog, catalogVersion, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CustomizationsApi();
            var catalog = catalog_example;  // String | Catalog identifier
            var catalogVersion = catalogVersion_example;  // String | Catalog version identifier
            var catalogs = catalogs_example;  // String | Filter for customization catalog. Requires personalizationcms extension. (optional) 
            var code = code_example;  // String | Filter for customization identifier. This filter don't work together with other filters (pageId, statuses, name) (optional) 
            var currentPage = 56;  // Integer | Current page number (optional) 
            var fields = fields_example;  // String | Response configuration (list of fields, which should be returned in response) (optional) 
            var name = name_example;  // String | Filter for customization name. This require also 'statuses' parameter to be set (optional) 
            var needsTotal = true;  // Boolean | Request total count (optional) 
            var negatePageId = true;  // Boolean | Flag to return customizations not related to page with 'pageId'. Requires personalizationcms extension. (optional) 
            var pageCatalogId = pageCatalogId_example;  // String | Page catalog identifier. Requires personalizationcms extension. (optional) 
            var pageId = pageId_example;  // String | Page identifier. This require also 'statuses' parameter to be set. Requires personalizationcms extension. (optional) 
            var pageSize = 56;  // Integer | Page size (optional) 
            var statuses = statuses_example;  // String | Comma separated customization statuses. Available statuses : ENABLED, DISABLED, DELETED (optional) 

            try
            {
                // Returns all customizations
                apiInstance.getCustomizations(catalog, catalogVersion, catalogs, code, currentPage, fields, name, needsTotal, negatePageId, pageCatalogId, pageId, pageSize, statuses);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomizationsApi.getCustomizations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCustomizationsApi();
$catalog = catalog_example; // String | Catalog identifier
$catalogVersion = catalogVersion_example; // String | Catalog version identifier
$catalogs = catalogs_example; // String | Filter for customization catalog. Requires personalizationcms extension.
$code = code_example; // String | Filter for customization identifier. This filter don't work together with other filters (pageId, statuses, name)
$currentPage = 56; // Integer | Current page number
$fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
$name = name_example; // String | Filter for customization name. This require also 'statuses' parameter to be set
$needsTotal = true; // Boolean | Request total count
$negatePageId = true; // Boolean | Flag to return customizations not related to page with 'pageId'. Requires personalizationcms extension.
$pageCatalogId = pageCatalogId_example; // String | Page catalog identifier. Requires personalizationcms extension.
$pageId = pageId_example; // String | Page identifier. This require also 'statuses' parameter to be set. Requires personalizationcms extension.
$pageSize = 56; // Integer | Page size
$statuses = statuses_example; // String | Comma separated customization statuses. Available statuses : ENABLED, DISABLED, DELETED

try {
    $api_instance->getCustomizations($catalog, $catalogVersion, $catalogs, $code, $currentPage, $fields, $name, $needsTotal, $negatePageId, $pageCatalogId, $pageId, $pageSize, $statuses);
} catch (Exception $e) {
    echo 'Exception when calling CustomizationsApi->getCustomizations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomizationsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CustomizationsApi->new();
my $catalog = catalog_example; # String | Catalog identifier
my $catalogVersion = catalogVersion_example; # String | Catalog version identifier
my $catalogs = catalogs_example; # String | Filter for customization catalog. Requires personalizationcms extension.
my $code = code_example; # String | Filter for customization identifier. This filter don't work together with other filters (pageId, statuses, name)
my $currentPage = 56; # Integer | Current page number
my $fields = fields_example; # String | Response configuration (list of fields, which should be returned in response)
my $name = name_example; # String | Filter for customization name. This require also 'statuses' parameter to be set
my $needsTotal = true; # Boolean | Request total count
my $negatePageId = true; # Boolean | Flag to return customizations not related to page with 'pageId'. Requires personalizationcms extension.
my $pageCatalogId = pageCatalogId_example; # String | Page catalog identifier. Requires personalizationcms extension.
my $pageId = pageId_example; # String | Page identifier. This require also 'statuses' parameter to be set. Requires personalizationcms extension.
my $pageSize = 56; # Integer | Page size
my $statuses = statuses_example; # String | Comma separated customization statuses. Available statuses : ENABLED, DISABLED, DELETED

eval { 
    $api_instance->getCustomizations(catalog => $catalog, catalogVersion => $catalogVersion, catalogs => $catalogs, code => $code, currentPage => $currentPage, fields => $fields, name => $name, needsTotal => $needsTotal, negatePageId => $negatePageId, pageCatalogId => $pageCatalogId, pageId => $pageId, pageSize => $pageSize, statuses => $statuses);
};
if ($@) {
    warn "Exception when calling CustomizationsApi->getCustomizations: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CustomizationsApi()
catalog = catalog_example # String | Catalog identifier
catalogVersion = catalogVersion_example # String | Catalog version identifier
catalogs = catalogs_example # String | Filter for customization catalog. Requires personalizationcms extension. (optional)
code = code_example # String | Filter for customization identifier. This filter don't work together with other filters (pageId, statuses, name) (optional)
currentPage = 56 # Integer | Current page number (optional)
fields = fields_example # String | Response configuration (list of fields, which should be returned in response) (optional)
name = name_example # String | Filter for customization name. This require also 'statuses' parameter to be set (optional)
needsTotal = true # Boolean | Request total count (optional)
negatePageId = true # Boolean | Flag to return customizations not related to page with 'pageId'. Requires personalizationcms extension. (optional)
pageCatalogId = pageCatalogId_example # String | Page catalog identifier. Requires personalizationcms extension. (optional)
pageId = pageId_example # String | Page identifier. This require also 'statuses' parameter to be set. Requires personalizationcms extension. (optional)
pageSize = 56 # Integer | Page size (optional)
statuses = statuses_example # String | Comma separated customization statuses. Available statuses : ENABLED, DISABLED, DELETED (optional)

try: 
    # Returns all customizations
    api_instance.get_customizations(catalog, catalogVersion, catalogs=catalogs, code=code, currentPage=currentPage, fields=fields, name=name, needsTotal=needsTotal, negatePageId=negatePageId, pageCatalogId=pageCatalogId, pageId=pageId, pageSize=pageSize, statuses=statuses)
except ApiException as e:
    print("Exception when calling CustomizationsApi->getCustomizations: %s\n" % e)

Parameters

Path parameters
Name Description
catalog*
String
Catalog identifier
Required
catalogVersion*
String
Catalog version identifier
Required
Query parameters
Name Description
catalogs
String
Filter for customization catalog. Requires personalizationcms extension.
code
String
Filter for customization identifier. This filter don't work together with other filters (pageId, statuses, name)
currentPage
Integer
Current page number
fields
String
Response configuration (list of fields, which should be returned in response)
name
String
Filter for customization name. This require also 'statuses' parameter to be set
needsTotal
Boolean
Request total count
negatePageId
Boolean
Flag to return customizations not related to page with 'pageId'. Requires personalizationcms extension.
pageCatalogId
String
Page catalog identifier. Requires personalizationcms extension.
pageId
String
Page identifier. This require also 'statuses' parameter to be set. Requires personalizationcms extension.
pageSize
Integer
Page size
statuses
String
Comma separated customization statuses. Available statuses : ENABLED, DISABLED, DELETED

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method or catalog with given id

Status: 404 - Catalog with given id doesn't exist


updateCustomization

Updates a customization


/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/personalizationwebservices/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomizationsApi;

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

public class CustomizationsApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        CustomizationsApi apiInstance = new CustomizationsApi();
        Customization body = ; // Customization | 
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        try {
            apiInstance.updateCustomization(body, catalog, catalogVersion, customizationCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomizationsApi#updateCustomization");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomizationsApi;

public class CustomizationsApiExample {

    public static void main(String[] args) {
        CustomizationsApi apiInstance = new CustomizationsApi();
        Customization body = ; // Customization | 
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        try {
            apiInstance.updateCustomization(body, catalog, catalogVersion, customizationCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomizationsApi#updateCustomization");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Customization *body = ; // 
String *catalog = catalog_example; // Catalog identifier
String *catalogVersion = catalogVersion_example; // Catalog version identifier
String *customizationCode = customizationCode_example; // Customization identifier

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

// Updates a customization
[apiInstance updateCustomizationWith:body
    catalog:catalog
    catalogVersion:catalogVersion
    customizationCode:customizationCode
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.CustomizationsApi()
var body = ; // {{Customization}} 
var catalog = catalog_example; // {{String}} Catalog identifier
var catalogVersion = catalogVersion_example; // {{String}} Catalog version identifier
var customizationCode = customizationCode_example; // {{String}} Customization identifier

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CustomizationsApi();
            var body = new Customization(); // Customization | 
            var catalog = catalog_example;  // String | Catalog identifier
            var catalogVersion = catalogVersion_example;  // String | Catalog version identifier
            var customizationCode = customizationCode_example;  // String | Customization identifier

            try
            {
                // Updates a customization
                apiInstance.updateCustomization(body, catalog, catalogVersion, customizationCode);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomizationsApi.updateCustomization: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCustomizationsApi();
$body = ; // Customization | 
$catalog = catalog_example; // String | Catalog identifier
$catalogVersion = catalogVersion_example; // String | Catalog version identifier
$customizationCode = customizationCode_example; // String | Customization identifier

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CustomizationsApi->new();
my $body = WWW::SwaggerClient::Object::Customization->new(); # Customization | 
my $catalog = catalog_example; # String | Catalog identifier
my $catalogVersion = catalogVersion_example; # String | Catalog version identifier
my $customizationCode = customizationCode_example; # String | Customization identifier

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CustomizationsApi()
body =  # Customization | 
catalog = catalog_example # String | Catalog identifier
catalogVersion = catalogVersion_example # String | Catalog version identifier
customizationCode = customizationCode_example # String | Customization identifier

try: 
    # Updates a customization
    api_instance.update_customization(body, catalog, catalogVersion, customizationCode)
except ApiException as e:
    print("Exception when calling CustomizationsApi->updateCustomization: %s\n" % e)

Parameters

Path parameters
Name Description
catalog*
String
Catalog identifier
Required
catalogVersion*
String
Catalog version identifier
Required
customizationCode*
String
Customization identifier
Required
Body parameters
Name Description
body *

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method or catalog with given id

Status: 404 - Catalog with given id doesn't exist

Status: 409 - Conflict - customization code in request body and url do not match


Query

executeQuery

Executes a query with given parameters.

The available queries depend on which extensions are included in your installation. Examples : cxpromotionsforcatalog, cxReplaceComponentWithContainer, etc...


/v1/query/{name}

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/personalizationwebservices/v1/query/{name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QueryApi;

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

public class QueryApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        QueryApi apiInstance = new QueryApi();
        QueryParams body = ; // QueryParams | 
        String name = name_example; // String | Query name
        try {
            apiInstance.executeQuery(body, name);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryApi#executeQuery");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.QueryApi;

public class QueryApiExample {

    public static void main(String[] args) {
        QueryApi apiInstance = new QueryApi();
        QueryParams body = ; // QueryParams | 
        String name = name_example; // String | Query name
        try {
            apiInstance.executeQuery(body, name);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueryApi#executeQuery");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
QueryParams *body = ; // 
String *name = name_example; // Query name

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

// Executes a query with given parameters.
[apiInstance executeQueryWith:body
    name:name
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.QueryApi()
var body = ; // {{QueryParams}} 
var name = name_example; // {{String}} Query name

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new QueryApi();
            var body = new QueryParams(); // QueryParams | 
            var name = name_example;  // String | Query name

            try
            {
                // Executes a query with given parameters.
                apiInstance.executeQuery(body, name);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QueryApi.executeQuery: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiQueryApi();
$body = ; // QueryParams | 
$name = name_example; // String | Query name

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::QueryApi->new();
my $body = WWW::SwaggerClient::Object::QueryParams->new(); # QueryParams | 
my $name = name_example; # String | Query name

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.QueryApi()
body =  # QueryParams | 
name = name_example # String | Query name

try: 
    # Executes a query with given parameters.
    api_instance.execute_query(body, name)
except ApiException as e:
    print("Exception when calling QueryApi->executeQuery: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
Query name
Required
Body parameters
Name Description
body *

Responses

Status: 400 - Bad Request e.g. incorrect request body data, missing parameters

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method

Status: 404 - Query with given name doesn't exist


Segments

createSegment

Creates segment

In default security configuration this endpoint is forbidden


/v1/segments

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/personalizationwebservices/v1/segments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SegmentsApi;

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

public class SegmentsApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

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

public class SegmentsApiExample {

    public static void main(String[] args) {
        SegmentsApi apiInstance = new SegmentsApi();
        Segment body = ; // Segment | 
        try {
            segment result = apiInstance.createSegment(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SegmentsApi#createSegment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Segment *body = ; // 

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

// Creates segment
[apiInstance createSegmentWith:body
              completionHandler: ^(segment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.SegmentsApi()
var body = ; // {{Segment}} 

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SegmentsApi();
            var body = new Segment(); // Segment | 

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

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSegmentsApi();
$body = ; // Segment | 

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

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

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

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

try: 
    # Creates segment
    api_response = api_instance.create_segment(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SegmentsApi->createSegment: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method

Status: 404 - Not Found

Status: 409 - Conflict - segment with given code already exists


deleteSegment

Deletes a segments

In default security configuration this endpoint is forbidden


/v1/segments/{segmentCode}

Usage and SDK Samples

curl -X DELETE\
\
\
"http://localhost:9001/personalizationwebservices/v1/segments/{segmentCode}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SegmentsApi;

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

public class SegmentsApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        SegmentsApi apiInstance = new SegmentsApi();
        String segmentCode = segmentCode_example; // String | Segment identifier
        try {
            apiInstance.deleteSegment(segmentCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling SegmentsApi#deleteSegment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SegmentsApi;

public class SegmentsApiExample {

    public static void main(String[] args) {
        SegmentsApi apiInstance = new SegmentsApi();
        String segmentCode = segmentCode_example; // String | Segment identifier
        try {
            apiInstance.deleteSegment(segmentCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling SegmentsApi#deleteSegment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *segmentCode = segmentCode_example; // Segment identifier

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

// Deletes a segments
[apiInstance deleteSegmentWith:segmentCode
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.SegmentsApi()
var segmentCode = segmentCode_example; // {{String}} Segment identifier

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SegmentsApi();
            var segmentCode = segmentCode_example;  // String | Segment identifier

            try
            {
                // Deletes a segments
                apiInstance.deleteSegment(segmentCode);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SegmentsApi.deleteSegment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSegmentsApi();
$segmentCode = segmentCode_example; // String | Segment identifier

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SegmentsApi->new();
my $segmentCode = segmentCode_example; # String | Segment identifier

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SegmentsApi()
segmentCode = segmentCode_example # String | Segment identifier

try: 
    # Deletes a segments
    api_instance.delete_segment(segmentCode)
except ApiException as e:
    print("Exception when calling SegmentsApi->deleteSegment: %s\n" % e)

Parameters

Path parameters
Name Description
segmentCode*
String
Segment identifier
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method

Status: 404 - Segment with given id doesn't exist


getSegment

Get a segment


/v1/segments/{segmentCode}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/personalizationwebservices/v1/segments/{segmentCode}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SegmentsApi;

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

public class SegmentsApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        SegmentsApi apiInstance = new SegmentsApi();
        String segmentCode = segmentCode_example; // String | Segment identifier
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
        try {
            apiInstance.getSegment(segmentCode, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling SegmentsApi#getSegment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SegmentsApi;

public class SegmentsApiExample {

    public static void main(String[] args) {
        SegmentsApi apiInstance = new SegmentsApi();
        String segmentCode = segmentCode_example; // String | Segment identifier
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
        try {
            apiInstance.getSegment(segmentCode, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling SegmentsApi#getSegment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *segmentCode = segmentCode_example; // Segment identifier
String *fields = fields_example; // Response configuration (list of fields, which should be returned in response) (optional)

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

// Get a segment
[apiInstance getSegmentWith:segmentCode
    fields:fields
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.SegmentsApi()
var segmentCode = segmentCode_example; // {{String}} Segment identifier
var opts = { 
  'fields': fields_example // {{String}} Response configuration (list of fields, which should be returned in response)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getSegment(segmentCode, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SegmentsApi();
            var segmentCode = segmentCode_example;  // String | Segment identifier
            var fields = fields_example;  // String | Response configuration (list of fields, which should be returned in response) (optional) 

            try
            {
                // Get a segment
                apiInstance.getSegment(segmentCode, fields);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SegmentsApi.getSegment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSegmentsApi();
$segmentCode = segmentCode_example; // String | Segment identifier
$fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SegmentsApi->new();
my $segmentCode = segmentCode_example; # String | Segment identifier
my $fields = fields_example; # String | Response configuration (list of fields, which should be returned in response)

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SegmentsApi()
segmentCode = segmentCode_example # String | Segment identifier
fields = fields_example # String | Response configuration (list of fields, which should be returned in response) (optional)

try: 
    # Get a segment
    api_instance.get_segment(segmentCode, fields=fields)
except ApiException as e:
    print("Exception when calling SegmentsApi->getSegment: %s\n" % e)

Parameters

Path parameters
Name Description
segmentCode*
String
Segment identifier
Required
Query parameters
Name Description
fields
String
Response configuration (list of fields, which should be returned in response)

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method

Status: 404 - Segment with given id doesn't exist


getSegments

Get all the segments

Endpoint returns all segments from the system


/v1/segments

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/personalizationwebservices/v1/segments?code=¤tPage=&fields=&needsTotal=&pageSize="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SegmentsApi;

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

public class SegmentsApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        SegmentsApi apiInstance = new SegmentsApi();
        String code = code_example; // String | Filter for segment identifier
        Integer currentPage = 56; // Integer | Current page number
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
        Boolean needsTotal = true; // Boolean | Request total count
        Integer pageSize = 56; // Integer | Page size
        try {
            apiInstance.getSegments(code, currentPage, fields, needsTotal, pageSize);
        } catch (ApiException e) {
            System.err.println("Exception when calling SegmentsApi#getSegments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SegmentsApi;

public class SegmentsApiExample {

    public static void main(String[] args) {
        SegmentsApi apiInstance = new SegmentsApi();
        String code = code_example; // String | Filter for segment identifier
        Integer currentPage = 56; // Integer | Current page number
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
        Boolean needsTotal = true; // Boolean | Request total count
        Integer pageSize = 56; // Integer | Page size
        try {
            apiInstance.getSegments(code, currentPage, fields, needsTotal, pageSize);
        } catch (ApiException e) {
            System.err.println("Exception when calling SegmentsApi#getSegments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *code = code_example; // Filter for segment identifier (optional)
Integer *currentPage = 56; // Current page number (optional)
String *fields = fields_example; // Response configuration (list of fields, which should be returned in response) (optional)
Boolean *needsTotal = true; // Request total count (optional)
Integer *pageSize = 56; // Page size (optional)

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

// Get all the segments
[apiInstance getSegmentsWith:code
    currentPage:currentPage
    fields:fields
    needsTotal:needsTotal
    pageSize:pageSize
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.SegmentsApi()
var opts = { 
  'code': code_example, // {{String}} Filter for segment identifier
  'currentPage': 56, // {{Integer}} Current page number
  'fields': fields_example, // {{String}} Response configuration (list of fields, which should be returned in response)
  'needsTotal': true, // {{Boolean}} Request total count
  'pageSize': 56 // {{Integer}} Page size
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getSegments(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SegmentsApi();
            var code = code_example;  // String | Filter for segment identifier (optional) 
            var currentPage = 56;  // Integer | Current page number (optional) 
            var fields = fields_example;  // String | Response configuration (list of fields, which should be returned in response) (optional) 
            var needsTotal = true;  // Boolean | Request total count (optional) 
            var pageSize = 56;  // Integer | Page size (optional) 

            try
            {
                // Get all the segments
                apiInstance.getSegments(code, currentPage, fields, needsTotal, pageSize);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SegmentsApi.getSegments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSegmentsApi();
$code = code_example; // String | Filter for segment identifier
$currentPage = 56; // Integer | Current page number
$fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
$needsTotal = true; // Boolean | Request total count
$pageSize = 56; // Integer | Page size

try {
    $api_instance->getSegments($code, $currentPage, $fields, $needsTotal, $pageSize);
} catch (Exception $e) {
    echo 'Exception when calling SegmentsApi->getSegments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SegmentsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SegmentsApi->new();
my $code = code_example; # String | Filter for segment identifier
my $currentPage = 56; # Integer | Current page number
my $fields = fields_example; # String | Response configuration (list of fields, which should be returned in response)
my $needsTotal = true; # Boolean | Request total count
my $pageSize = 56; # Integer | Page size

eval { 
    $api_instance->getSegments(code => $code, currentPage => $currentPage, fields => $fields, needsTotal => $needsTotal, pageSize => $pageSize);
};
if ($@) {
    warn "Exception when calling SegmentsApi->getSegments: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SegmentsApi()
code = code_example # String | Filter for segment identifier (optional)
currentPage = 56 # Integer | Current page number (optional)
fields = fields_example # String | Response configuration (list of fields, which should be returned in response) (optional)
needsTotal = true # Boolean | Request total count (optional)
pageSize = 56 # Integer | Page size (optional)

try: 
    # Get all the segments
    api_instance.get_segments(code=code, currentPage=currentPage, fields=fields, needsTotal=needsTotal, pageSize=pageSize)
except ApiException as e:
    print("Exception when calling SegmentsApi->getSegments: %s\n" % e)

Parameters

Query parameters
Name Description
code
String
Filter for segment identifier
currentPage
Integer
Current page number
fields
String
Response configuration (list of fields, which should be returned in response)
needsTotal
Boolean
Request total count
pageSize
Integer
Page size

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method

Status: 404 - Not Found


updateSegment

Updates a segment

In default security configuration this endpoint is forbidden


/v1/segments/{segmentCode}

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/personalizationwebservices/v1/segments/{segmentCode}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SegmentsApi;

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

public class SegmentsApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        SegmentsApi apiInstance = new SegmentsApi();
        Segment body = ; // Segment | 
        String segmentCode = segmentCode_example; // String | Segment identifier
        try {
            apiInstance.updateSegment(body, segmentCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling SegmentsApi#updateSegment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SegmentsApi;

public class SegmentsApiExample {

    public static void main(String[] args) {
        SegmentsApi apiInstance = new SegmentsApi();
        Segment body = ; // Segment | 
        String segmentCode = segmentCode_example; // String | Segment identifier
        try {
            apiInstance.updateSegment(body, segmentCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling SegmentsApi#updateSegment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Segment *body = ; // 
String *segmentCode = segmentCode_example; // Segment identifier

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

// Updates a segment
[apiInstance updateSegmentWith:body
    segmentCode:segmentCode
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.SegmentsApi()
var body = ; // {{Segment}} 
var segmentCode = segmentCode_example; // {{String}} Segment identifier

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SegmentsApi();
            var body = new Segment(); // Segment | 
            var segmentCode = segmentCode_example;  // String | Segment identifier

            try
            {
                // Updates a segment
                apiInstance.updateSegment(body, segmentCode);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SegmentsApi.updateSegment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSegmentsApi();
$body = ; // Segment | 
$segmentCode = segmentCode_example; // String | Segment identifier

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SegmentsApi->new();
my $body = WWW::SwaggerClient::Object::Segment->new(); # Segment | 
my $segmentCode = segmentCode_example; # String | Segment identifier

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SegmentsApi()
body =  # Segment | 
segmentCode = segmentCode_example # String | Segment identifier

try: 
    # Updates a segment
    api_instance.update_segment(body, segmentCode)
except ApiException as e:
    print("Exception when calling SegmentsApi->updateSegment: %s\n" % e)

Parameters

Path parameters
Name Description
segmentCode*
String
Segment identifier
Required
Body parameters
Name Description
body *

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method

Status: 404 - Segment with given id doesn't exist

Status: 409 - Conflict - segment code in request body and url do not match


Triggers

createTrigger

Create a trigger for a given variation


/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/triggers

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/personalizationwebservices/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/triggers"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TriggersApi;

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

public class TriggersApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TriggersApi apiInstance = new TriggersApi();
        Trigger body = ; // Trigger | 
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String variationCode = variationCode_example; // String | Variation identifier
        try {
            trigger result = apiInstance.createTrigger(body, catalog, catalogVersion, customizationCode, variationCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TriggersApi#createTrigger");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TriggersApi;

public class TriggersApiExample {

    public static void main(String[] args) {
        TriggersApi apiInstance = new TriggersApi();
        Trigger body = ; // Trigger | 
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String variationCode = variationCode_example; // String | Variation identifier
        try {
            trigger result = apiInstance.createTrigger(body, catalog, catalogVersion, customizationCode, variationCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TriggersApi#createTrigger");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Trigger *body = ; // 
String *catalog = catalog_example; // Catalog identifier
String *catalogVersion = catalogVersion_example; // Catalog version identifier
String *customizationCode = customizationCode_example; // Customization identifier
String *variationCode = variationCode_example; // Variation identifier

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

// Create a trigger for a given variation
[apiInstance createTriggerWith:body
    catalog:catalog
    catalogVersion:catalogVersion
    customizationCode:customizationCode
    variationCode:variationCode
              completionHandler: ^(trigger output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.TriggersApi()
var body = ; // {{Trigger}} 
var catalog = catalog_example; // {{String}} Catalog identifier
var catalogVersion = catalogVersion_example; // {{String}} Catalog version identifier
var customizationCode = customizationCode_example; // {{String}} Customization identifier
var variationCode = variationCode_example; // {{String}} Variation identifier

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TriggersApi();
            var body = new Trigger(); // Trigger | 
            var catalog = catalog_example;  // String | Catalog identifier
            var catalogVersion = catalogVersion_example;  // String | Catalog version identifier
            var customizationCode = customizationCode_example;  // String | Customization identifier
            var variationCode = variationCode_example;  // String | Variation identifier

            try
            {
                // Create a trigger for a given variation
                trigger result = apiInstance.createTrigger(body, catalog, catalogVersion, customizationCode, variationCode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TriggersApi.createTrigger: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTriggersApi();
$body = ; // Trigger | 
$catalog = catalog_example; // String | Catalog identifier
$catalogVersion = catalogVersion_example; // String | Catalog version identifier
$customizationCode = customizationCode_example; // String | Customization identifier
$variationCode = variationCode_example; // String | Variation identifier

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TriggersApi->new();
my $body = WWW::SwaggerClient::Object::Trigger->new(); # Trigger | 
my $catalog = catalog_example; # String | Catalog identifier
my $catalogVersion = catalogVersion_example; # String | Catalog version identifier
my $customizationCode = customizationCode_example; # String | Customization identifier
my $variationCode = variationCode_example; # String | Variation identifier

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TriggersApi()
body =  # Trigger | 
catalog = catalog_example # String | Catalog identifier
catalogVersion = catalogVersion_example # String | Catalog version identifier
customizationCode = customizationCode_example # String | Customization identifier
variationCode = variationCode_example # String | Variation identifier

try: 
    # Create a trigger for a given variation
    api_response = api_instance.create_trigger(body, catalog, catalogVersion, customizationCode, variationCode)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TriggersApi->createTrigger: %s\n" % e)

Parameters

Path parameters
Name Description
catalog*
String
Catalog identifier
Required
catalogVersion*
String
Catalog version identifier
Required
customizationCode*
String
Customization identifier
Required
variationCode*
String
Variation identifier
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method or catalog with given id

Status: 404 - Catalog, customization or variation with given id doesn't exist

Status: 409 - Conflict - trigger with given code already exists


deleteTrigger

Deletes a trigger


/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/triggers/{triggerCode}

Usage and SDK Samples

curl -X DELETE\
\
\
"http://localhost:9001/personalizationwebservices/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/triggers/{triggerCode}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TriggersApi;

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

public class TriggersApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TriggersApi apiInstance = new TriggersApi();
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String triggerCode = triggerCode_example; // String | Trigger identifier
        String variationCode = variationCode_example; // String | Variation identifier
        try {
            apiInstance.deleteTrigger(catalog, catalogVersion, customizationCode, triggerCode, variationCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling TriggersApi#deleteTrigger");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TriggersApi;

public class TriggersApiExample {

    public static void main(String[] args) {
        TriggersApi apiInstance = new TriggersApi();
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String triggerCode = triggerCode_example; // String | Trigger identifier
        String variationCode = variationCode_example; // String | Variation identifier
        try {
            apiInstance.deleteTrigger(catalog, catalogVersion, customizationCode, triggerCode, variationCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling TriggersApi#deleteTrigger");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *catalog = catalog_example; // Catalog identifier
String *catalogVersion = catalogVersion_example; // Catalog version identifier
String *customizationCode = customizationCode_example; // Customization identifier
String *triggerCode = triggerCode_example; // Trigger identifier
String *variationCode = variationCode_example; // Variation identifier

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

// Deletes a trigger
[apiInstance deleteTriggerWith:catalog
    catalogVersion:catalogVersion
    customizationCode:customizationCode
    triggerCode:triggerCode
    variationCode:variationCode
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.TriggersApi()
var catalog = catalog_example; // {{String}} Catalog identifier
var catalogVersion = catalogVersion_example; // {{String}} Catalog version identifier
var customizationCode = customizationCode_example; // {{String}} Customization identifier
var triggerCode = triggerCode_example; // {{String}} Trigger identifier
var variationCode = variationCode_example; // {{String}} Variation identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteTrigger(catalog, catalogVersion, customizationCode, triggerCode, variationCode, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TriggersApi();
            var catalog = catalog_example;  // String | Catalog identifier
            var catalogVersion = catalogVersion_example;  // String | Catalog version identifier
            var customizationCode = customizationCode_example;  // String | Customization identifier
            var triggerCode = triggerCode_example;  // String | Trigger identifier
            var variationCode = variationCode_example;  // String | Variation identifier

            try
            {
                // Deletes a trigger
                apiInstance.deleteTrigger(catalog, catalogVersion, customizationCode, triggerCode, variationCode);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TriggersApi.deleteTrigger: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTriggersApi();
$catalog = catalog_example; // String | Catalog identifier
$catalogVersion = catalogVersion_example; // String | Catalog version identifier
$customizationCode = customizationCode_example; // String | Customization identifier
$triggerCode = triggerCode_example; // String | Trigger identifier
$variationCode = variationCode_example; // String | Variation identifier

try {
    $api_instance->deleteTrigger($catalog, $catalogVersion, $customizationCode, $triggerCode, $variationCode);
} catch (Exception $e) {
    echo 'Exception when calling TriggersApi->deleteTrigger: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TriggersApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TriggersApi->new();
my $catalog = catalog_example; # String | Catalog identifier
my $catalogVersion = catalogVersion_example; # String | Catalog version identifier
my $customizationCode = customizationCode_example; # String | Customization identifier
my $triggerCode = triggerCode_example; # String | Trigger identifier
my $variationCode = variationCode_example; # String | Variation identifier

eval { 
    $api_instance->deleteTrigger(catalog => $catalog, catalogVersion => $catalogVersion, customizationCode => $customizationCode, triggerCode => $triggerCode, variationCode => $variationCode);
};
if ($@) {
    warn "Exception when calling TriggersApi->deleteTrigger: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TriggersApi()
catalog = catalog_example # String | Catalog identifier
catalogVersion = catalogVersion_example # String | Catalog version identifier
customizationCode = customizationCode_example # String | Customization identifier
triggerCode = triggerCode_example # String | Trigger identifier
variationCode = variationCode_example # String | Variation identifier

try: 
    # Deletes a trigger
    api_instance.delete_trigger(catalog, catalogVersion, customizationCode, triggerCode, variationCode)
except ApiException as e:
    print("Exception when calling TriggersApi->deleteTrigger: %s\n" % e)

Parameters

Path parameters
Name Description
catalog*
String
Catalog identifier
Required
catalogVersion*
String
Catalog version identifier
Required
customizationCode*
String
Customization identifier
Required
triggerCode*
String
Trigger identifier
Required
variationCode*
String
Variation identifier
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method or catalog with given id

Status: 404 - Catalog, customization or variation with given id doesn't exist


getTrigger

Get a specific trigger


/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/triggers/{triggerCode}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/personalizationwebservices/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/triggers/{triggerCode}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TriggersApi;

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

public class TriggersApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TriggersApi apiInstance = new TriggersApi();
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String triggerCode = triggerCode_example; // String | Trigger identifier
        String variationCode = variationCode_example; // String | Variation identifier
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
        try {
            apiInstance.getTrigger(catalog, catalogVersion, customizationCode, triggerCode, variationCode, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling TriggersApi#getTrigger");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TriggersApi;

public class TriggersApiExample {

    public static void main(String[] args) {
        TriggersApi apiInstance = new TriggersApi();
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String triggerCode = triggerCode_example; // String | Trigger identifier
        String variationCode = variationCode_example; // String | Variation identifier
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
        try {
            apiInstance.getTrigger(catalog, catalogVersion, customizationCode, triggerCode, variationCode, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling TriggersApi#getTrigger");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *catalog = catalog_example; // Catalog identifier
String *catalogVersion = catalogVersion_example; // Catalog version identifier
String *customizationCode = customizationCode_example; // Customization identifier
String *triggerCode = triggerCode_example; // Trigger identifier
String *variationCode = variationCode_example; // Variation identifier
String *fields = fields_example; // Response configuration (list of fields, which should be returned in response) (optional)

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

// Get a specific trigger
[apiInstance getTriggerWith:catalog
    catalogVersion:catalogVersion
    customizationCode:customizationCode
    triggerCode:triggerCode
    variationCode:variationCode
    fields:fields
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.TriggersApi()
var catalog = catalog_example; // {{String}} Catalog identifier
var catalogVersion = catalogVersion_example; // {{String}} Catalog version identifier
var customizationCode = customizationCode_example; // {{String}} Customization identifier
var triggerCode = triggerCode_example; // {{String}} Trigger identifier
var variationCode = variationCode_example; // {{String}} Variation identifier
var opts = { 
  'fields': fields_example // {{String}} Response configuration (list of fields, which should be returned in response)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getTrigger(catalog, catalogVersion, customizationCode, triggerCode, variationCode, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TriggersApi();
            var catalog = catalog_example;  // String | Catalog identifier
            var catalogVersion = catalogVersion_example;  // String | Catalog version identifier
            var customizationCode = customizationCode_example;  // String | Customization identifier
            var triggerCode = triggerCode_example;  // String | Trigger identifier
            var variationCode = variationCode_example;  // String | Variation identifier
            var fields = fields_example;  // String | Response configuration (list of fields, which should be returned in response) (optional) 

            try
            {
                // Get a specific trigger
                apiInstance.getTrigger(catalog, catalogVersion, customizationCode, triggerCode, variationCode, fields);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TriggersApi.getTrigger: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTriggersApi();
$catalog = catalog_example; // String | Catalog identifier
$catalogVersion = catalogVersion_example; // String | Catalog version identifier
$customizationCode = customizationCode_example; // String | Customization identifier
$triggerCode = triggerCode_example; // String | Trigger identifier
$variationCode = variationCode_example; // String | Variation identifier
$fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)

try {
    $api_instance->getTrigger($catalog, $catalogVersion, $customizationCode, $triggerCode, $variationCode, $fields);
} catch (Exception $e) {
    echo 'Exception when calling TriggersApi->getTrigger: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TriggersApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TriggersApi->new();
my $catalog = catalog_example; # String | Catalog identifier
my $catalogVersion = catalogVersion_example; # String | Catalog version identifier
my $customizationCode = customizationCode_example; # String | Customization identifier
my $triggerCode = triggerCode_example; # String | Trigger identifier
my $variationCode = variationCode_example; # String | Variation identifier
my $fields = fields_example; # String | Response configuration (list of fields, which should be returned in response)

eval { 
    $api_instance->getTrigger(catalog => $catalog, catalogVersion => $catalogVersion, customizationCode => $customizationCode, triggerCode => $triggerCode, variationCode => $variationCode, fields => $fields);
};
if ($@) {
    warn "Exception when calling TriggersApi->getTrigger: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TriggersApi()
catalog = catalog_example # String | Catalog identifier
catalogVersion = catalogVersion_example # String | Catalog version identifier
customizationCode = customizationCode_example # String | Customization identifier
triggerCode = triggerCode_example # String | Trigger identifier
variationCode = variationCode_example # String | Variation identifier
fields = fields_example # String | Response configuration (list of fields, which should be returned in response) (optional)

try: 
    # Get a specific trigger
    api_instance.get_trigger(catalog, catalogVersion, customizationCode, triggerCode, variationCode, fields=fields)
except ApiException as e:
    print("Exception when calling TriggersApi->getTrigger: %s\n" % e)

Parameters

Path parameters
Name Description
catalog*
String
Catalog identifier
Required
catalogVersion*
String
Catalog version identifier
Required
customizationCode*
String
Customization identifier
Required
triggerCode*
String
Trigger identifier
Required
variationCode*
String
Variation identifier
Required
Query parameters
Name Description
fields
String
Response configuration (list of fields, which should be returned in response)

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method or catalog with given id

Status: 404 - Catalog, customization or variation with given id doesn't exist


getTriggers

Get triggers for a given variation


/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/triggers

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/personalizationwebservices/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/triggers?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TriggersApi;

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

public class TriggersApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TriggersApi apiInstance = new TriggersApi();
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String variationCode = variationCode_example; // String | Variation identifier
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
        try {
            apiInstance.getTriggers(catalog, catalogVersion, customizationCode, variationCode, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling TriggersApi#getTriggers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TriggersApi;

public class TriggersApiExample {

    public static void main(String[] args) {
        TriggersApi apiInstance = new TriggersApi();
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String variationCode = variationCode_example; // String | Variation identifier
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
        try {
            apiInstance.getTriggers(catalog, catalogVersion, customizationCode, variationCode, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling TriggersApi#getTriggers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *catalog = catalog_example; // Catalog identifier
String *catalogVersion = catalogVersion_example; // Catalog version identifier
String *customizationCode = customizationCode_example; // Customization identifier
String *variationCode = variationCode_example; // Variation identifier
String *fields = fields_example; // Response configuration (list of fields, which should be returned in response) (optional)

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

// Get triggers for a given variation
[apiInstance getTriggersWith:catalog
    catalogVersion:catalogVersion
    customizationCode:customizationCode
    variationCode:variationCode
    fields:fields
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.TriggersApi()
var catalog = catalog_example; // {{String}} Catalog identifier
var catalogVersion = catalogVersion_example; // {{String}} Catalog version identifier
var customizationCode = customizationCode_example; // {{String}} Customization identifier
var variationCode = variationCode_example; // {{String}} Variation identifier
var opts = { 
  'fields': fields_example // {{String}} Response configuration (list of fields, which should be returned in response)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getTriggers(catalog, catalogVersion, customizationCode, variationCode, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TriggersApi();
            var catalog = catalog_example;  // String | Catalog identifier
            var catalogVersion = catalogVersion_example;  // String | Catalog version identifier
            var customizationCode = customizationCode_example;  // String | Customization identifier
            var variationCode = variationCode_example;  // String | Variation identifier
            var fields = fields_example;  // String | Response configuration (list of fields, which should be returned in response) (optional) 

            try
            {
                // Get triggers for a given variation
                apiInstance.getTriggers(catalog, catalogVersion, customizationCode, variationCode, fields);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TriggersApi.getTriggers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTriggersApi();
$catalog = catalog_example; // String | Catalog identifier
$catalogVersion = catalogVersion_example; // String | Catalog version identifier
$customizationCode = customizationCode_example; // String | Customization identifier
$variationCode = variationCode_example; // String | Variation identifier
$fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)

try {
    $api_instance->getTriggers($catalog, $catalogVersion, $customizationCode, $variationCode, $fields);
} catch (Exception $e) {
    echo 'Exception when calling TriggersApi->getTriggers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TriggersApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TriggersApi->new();
my $catalog = catalog_example; # String | Catalog identifier
my $catalogVersion = catalogVersion_example; # String | Catalog version identifier
my $customizationCode = customizationCode_example; # String | Customization identifier
my $variationCode = variationCode_example; # String | Variation identifier
my $fields = fields_example; # String | Response configuration (list of fields, which should be returned in response)

eval { 
    $api_instance->getTriggers(catalog => $catalog, catalogVersion => $catalogVersion, customizationCode => $customizationCode, variationCode => $variationCode, fields => $fields);
};
if ($@) {
    warn "Exception when calling TriggersApi->getTriggers: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TriggersApi()
catalog = catalog_example # String | Catalog identifier
catalogVersion = catalogVersion_example # String | Catalog version identifier
customizationCode = customizationCode_example # String | Customization identifier
variationCode = variationCode_example # String | Variation identifier
fields = fields_example # String | Response configuration (list of fields, which should be returned in response) (optional)

try: 
    # Get triggers for a given variation
    api_instance.get_triggers(catalog, catalogVersion, customizationCode, variationCode, fields=fields)
except ApiException as e:
    print("Exception when calling TriggersApi->getTriggers: %s\n" % e)

Parameters

Path parameters
Name Description
catalog*
String
Catalog identifier
Required
catalogVersion*
String
Catalog version identifier
Required
customizationCode*
String
Customization identifier
Required
variationCode*
String
Variation identifier
Required
Query parameters
Name Description
fields
String
Response configuration (list of fields, which should be returned in response)

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method or catalog with given id

Status: 404 - Catalog, customization or variation with given id doesn't exist


updateTrigger

Updates a trigger


/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/triggers/{triggerCode}

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/personalizationwebservices/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/triggers/{triggerCode}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TriggersApi;

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

public class TriggersApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        TriggersApi apiInstance = new TriggersApi();
        Trigger body = ; // Trigger | 
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String triggerCode = triggerCode_example; // String | Trigger identifier
        String variationCode = variationCode_example; // String | Variation identifier
        try {
            apiInstance.updateTrigger(body, catalog, catalogVersion, customizationCode, triggerCode, variationCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling TriggersApi#updateTrigger");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TriggersApi;

public class TriggersApiExample {

    public static void main(String[] args) {
        TriggersApi apiInstance = new TriggersApi();
        Trigger body = ; // Trigger | 
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String triggerCode = triggerCode_example; // String | Trigger identifier
        String variationCode = variationCode_example; // String | Variation identifier
        try {
            apiInstance.updateTrigger(body, catalog, catalogVersion, customizationCode, triggerCode, variationCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling TriggersApi#updateTrigger");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Trigger *body = ; // 
String *catalog = catalog_example; // Catalog identifier
String *catalogVersion = catalogVersion_example; // Catalog version identifier
String *customizationCode = customizationCode_example; // Customization identifier
String *triggerCode = triggerCode_example; // Trigger identifier
String *variationCode = variationCode_example; // Variation identifier

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

// Updates a trigger
[apiInstance updateTriggerWith:body
    catalog:catalog
    catalogVersion:catalogVersion
    customizationCode:customizationCode
    triggerCode:triggerCode
    variationCode:variationCode
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.TriggersApi()
var body = ; // {{Trigger}} 
var catalog = catalog_example; // {{String}} Catalog identifier
var catalogVersion = catalogVersion_example; // {{String}} Catalog version identifier
var customizationCode = customizationCode_example; // {{String}} Customization identifier
var triggerCode = triggerCode_example; // {{String}} Trigger identifier
var variationCode = variationCode_example; // {{String}} Variation identifier

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new TriggersApi();
            var body = new Trigger(); // Trigger | 
            var catalog = catalog_example;  // String | Catalog identifier
            var catalogVersion = catalogVersion_example;  // String | Catalog version identifier
            var customizationCode = customizationCode_example;  // String | Customization identifier
            var triggerCode = triggerCode_example;  // String | Trigger identifier
            var variationCode = variationCode_example;  // String | Variation identifier

            try
            {
                // Updates a trigger
                apiInstance.updateTrigger(body, catalog, catalogVersion, customizationCode, triggerCode, variationCode);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TriggersApi.updateTrigger: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiTriggersApi();
$body = ; // Trigger | 
$catalog = catalog_example; // String | Catalog identifier
$catalogVersion = catalogVersion_example; // String | Catalog version identifier
$customizationCode = customizationCode_example; // String | Customization identifier
$triggerCode = triggerCode_example; // String | Trigger identifier
$variationCode = variationCode_example; // String | Variation identifier

try {
    $api_instance->updateTrigger($body, $catalog, $catalogVersion, $customizationCode, $triggerCode, $variationCode);
} catch (Exception $e) {
    echo 'Exception when calling TriggersApi->updateTrigger: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TriggersApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::TriggersApi->new();
my $body = WWW::SwaggerClient::Object::Trigger->new(); # Trigger | 
my $catalog = catalog_example; # String | Catalog identifier
my $catalogVersion = catalogVersion_example; # String | Catalog version identifier
my $customizationCode = customizationCode_example; # String | Customization identifier
my $triggerCode = triggerCode_example; # String | Trigger identifier
my $variationCode = variationCode_example; # String | Variation identifier

eval { 
    $api_instance->updateTrigger(body => $body, catalog => $catalog, catalogVersion => $catalogVersion, customizationCode => $customizationCode, triggerCode => $triggerCode, variationCode => $variationCode);
};
if ($@) {
    warn "Exception when calling TriggersApi->updateTrigger: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.TriggersApi()
body =  # Trigger | 
catalog = catalog_example # String | Catalog identifier
catalogVersion = catalogVersion_example # String | Catalog version identifier
customizationCode = customizationCode_example # String | Customization identifier
triggerCode = triggerCode_example # String | Trigger identifier
variationCode = variationCode_example # String | Variation identifier

try: 
    # Updates a trigger
    api_instance.update_trigger(body, catalog, catalogVersion, customizationCode, triggerCode, variationCode)
except ApiException as e:
    print("Exception when calling TriggersApi->updateTrigger: %s\n" % e)

Parameters

Path parameters
Name Description
catalog*
String
Catalog identifier
Required
catalogVersion*
String
Catalog version identifier
Required
customizationCode*
String
Customization identifier
Required
triggerCode*
String
Trigger identifier
Required
variationCode*
String
Variation identifier
Required
Body parameters
Name Description
body *

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method or catalog with given id

Status: 404 - Catalog, customization or variation with given id doesn't exist

Status: 409 - Conflict - trigger code in request body and url do not match


Variations

createVariation

Creates a new variations part of a given customization


/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/personalizationwebservices/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VariationsApi;

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

public class VariationsApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        VariationsApi apiInstance = new VariationsApi();
        Variation body = ; // Variation | 
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        try {
            variation result = apiInstance.createVariation(body, catalog, catalogVersion, customizationCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VariationsApi#createVariation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VariationsApi;

public class VariationsApiExample {

    public static void main(String[] args) {
        VariationsApi apiInstance = new VariationsApi();
        Variation body = ; // Variation | 
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        try {
            variation result = apiInstance.createVariation(body, catalog, catalogVersion, customizationCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VariationsApi#createVariation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Variation *body = ; // 
String *catalog = catalog_example; // Catalog identifier
String *catalogVersion = catalogVersion_example; // Catalog version identifier
String *customizationCode = customizationCode_example; // Customization identifier

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

// Creates a new variations part of a given customization
[apiInstance createVariationWith:body
    catalog:catalog
    catalogVersion:catalogVersion
    customizationCode:customizationCode
              completionHandler: ^(variation output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.VariationsApi()
var body = ; // {{Variation}} 
var catalog = catalog_example; // {{String}} Catalog identifier
var catalogVersion = catalogVersion_example; // {{String}} Catalog version identifier
var customizationCode = customizationCode_example; // {{String}} Customization identifier

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new VariationsApi();
            var body = new Variation(); // Variation | 
            var catalog = catalog_example;  // String | Catalog identifier
            var catalogVersion = catalogVersion_example;  // String | Catalog version identifier
            var customizationCode = customizationCode_example;  // String | Customization identifier

            try
            {
                // Creates a new variations part of a given customization
                variation result = apiInstance.createVariation(body, catalog, catalogVersion, customizationCode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VariationsApi.createVariation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiVariationsApi();
$body = ; // Variation | 
$catalog = catalog_example; // String | Catalog identifier
$catalogVersion = catalogVersion_example; // String | Catalog version identifier
$customizationCode = customizationCode_example; // String | Customization identifier

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::VariationsApi->new();
my $body = WWW::SwaggerClient::Object::Variation->new(); # Variation | 
my $catalog = catalog_example; # String | Catalog identifier
my $catalogVersion = catalogVersion_example; # String | Catalog version identifier
my $customizationCode = customizationCode_example; # String | Customization identifier

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.VariationsApi()
body =  # Variation | 
catalog = catalog_example # String | Catalog identifier
catalogVersion = catalogVersion_example # String | Catalog version identifier
customizationCode = customizationCode_example # String | Customization identifier

try: 
    # Creates a new variations part of a given customization
    api_response = api_instance.create_variation(body, catalog, catalogVersion, customizationCode)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VariationsApi->createVariation: %s\n" % e)

Parameters

Path parameters
Name Description
catalog*
String
Catalog identifier
Required
catalogVersion*
String
Catalog version identifier
Required
customizationCode*
String
Customization identifier
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method or catalog with given id

Status: 404 - Catalog or customization with given id doesn't exist

Status: 409 - Conflict - variation with given code already exists


deleteVariation

Delete an existing variation


/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}

Usage and SDK Samples

curl -X DELETE\
\
\
"http://localhost:9001/personalizationwebservices/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VariationsApi;

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

public class VariationsApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        VariationsApi apiInstance = new VariationsApi();
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String variationCode = variationCode_example; // String | Variation identifier
        try {
            apiInstance.deleteVariation(catalog, catalogVersion, customizationCode, variationCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling VariationsApi#deleteVariation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VariationsApi;

public class VariationsApiExample {

    public static void main(String[] args) {
        VariationsApi apiInstance = new VariationsApi();
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String variationCode = variationCode_example; // String | Variation identifier
        try {
            apiInstance.deleteVariation(catalog, catalogVersion, customizationCode, variationCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling VariationsApi#deleteVariation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *catalog = catalog_example; // Catalog identifier
String *catalogVersion = catalogVersion_example; // Catalog version identifier
String *customizationCode = customizationCode_example; // Customization identifier
String *variationCode = variationCode_example; // Variation identifier

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

// Delete an existing variation
[apiInstance deleteVariationWith:catalog
    catalogVersion:catalogVersion
    customizationCode:customizationCode
    variationCode:variationCode
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.VariationsApi()
var catalog = catalog_example; // {{String}} Catalog identifier
var catalogVersion = catalogVersion_example; // {{String}} Catalog version identifier
var customizationCode = customizationCode_example; // {{String}} Customization identifier
var variationCode = variationCode_example; // {{String}} Variation identifier

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new VariationsApi();
            var catalog = catalog_example;  // String | Catalog identifier
            var catalogVersion = catalogVersion_example;  // String | Catalog version identifier
            var customizationCode = customizationCode_example;  // String | Customization identifier
            var variationCode = variationCode_example;  // String | Variation identifier

            try
            {
                // Delete an existing variation
                apiInstance.deleteVariation(catalog, catalogVersion, customizationCode, variationCode);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VariationsApi.deleteVariation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiVariationsApi();
$catalog = catalog_example; // String | Catalog identifier
$catalogVersion = catalogVersion_example; // String | Catalog version identifier
$customizationCode = customizationCode_example; // String | Customization identifier
$variationCode = variationCode_example; // String | Variation identifier

try {
    $api_instance->deleteVariation($catalog, $catalogVersion, $customizationCode, $variationCode);
} catch (Exception $e) {
    echo 'Exception when calling VariationsApi->deleteVariation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VariationsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::VariationsApi->new();
my $catalog = catalog_example; # String | Catalog identifier
my $catalogVersion = catalogVersion_example; # String | Catalog version identifier
my $customizationCode = customizationCode_example; # String | Customization identifier
my $variationCode = variationCode_example; # String | Variation identifier

eval { 
    $api_instance->deleteVariation(catalog => $catalog, catalogVersion => $catalogVersion, customizationCode => $customizationCode, variationCode => $variationCode);
};
if ($@) {
    warn "Exception when calling VariationsApi->deleteVariation: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.VariationsApi()
catalog = catalog_example # String | Catalog identifier
catalogVersion = catalogVersion_example # String | Catalog version identifier
customizationCode = customizationCode_example # String | Customization identifier
variationCode = variationCode_example # String | Variation identifier

try: 
    # Delete an existing variation
    api_instance.delete_variation(catalog, catalogVersion, customizationCode, variationCode)
except ApiException as e:
    print("Exception when calling VariationsApi->deleteVariation: %s\n" % e)

Parameters

Path parameters
Name Description
catalog*
String
Catalog identifier
Required
catalogVersion*
String
Catalog version identifier
Required
customizationCode*
String
Customization identifier
Required
variationCode*
String
Variation identifier
Required

Responses

Status: 204 - No Content

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method or catalog with given id

Status: 404 - Catalog, customization or variation with given id doesn't exist


getVariation

Returns an existing variation


/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/personalizationwebservices/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VariationsApi;

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

public class VariationsApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        VariationsApi apiInstance = new VariationsApi();
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String variationCode = variationCode_example; // String | Variation identifier
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
        try {
            apiInstance.getVariation(catalog, catalogVersion, customizationCode, variationCode, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling VariationsApi#getVariation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VariationsApi;

public class VariationsApiExample {

    public static void main(String[] args) {
        VariationsApi apiInstance = new VariationsApi();
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String variationCode = variationCode_example; // String | Variation identifier
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
        try {
            apiInstance.getVariation(catalog, catalogVersion, customizationCode, variationCode, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling VariationsApi#getVariation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *catalog = catalog_example; // Catalog identifier
String *catalogVersion = catalogVersion_example; // Catalog version identifier
String *customizationCode = customizationCode_example; // Customization identifier
String *variationCode = variationCode_example; // Variation identifier
String *fields = fields_example; // Response configuration (list of fields, which should be returned in response) (optional)

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

// Returns an existing variation
[apiInstance getVariationWith:catalog
    catalogVersion:catalogVersion
    customizationCode:customizationCode
    variationCode:variationCode
    fields:fields
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.VariationsApi()
var catalog = catalog_example; // {{String}} Catalog identifier
var catalogVersion = catalogVersion_example; // {{String}} Catalog version identifier
var customizationCode = customizationCode_example; // {{String}} Customization identifier
var variationCode = variationCode_example; // {{String}} Variation identifier
var opts = { 
  'fields': fields_example // {{String}} Response configuration (list of fields, which should be returned in response)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getVariation(catalog, catalogVersion, customizationCode, variationCode, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new VariationsApi();
            var catalog = catalog_example;  // String | Catalog identifier
            var catalogVersion = catalogVersion_example;  // String | Catalog version identifier
            var customizationCode = customizationCode_example;  // String | Customization identifier
            var variationCode = variationCode_example;  // String | Variation identifier
            var fields = fields_example;  // String | Response configuration (list of fields, which should be returned in response) (optional) 

            try
            {
                // Returns an existing variation
                apiInstance.getVariation(catalog, catalogVersion, customizationCode, variationCode, fields);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VariationsApi.getVariation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiVariationsApi();
$catalog = catalog_example; // String | Catalog identifier
$catalogVersion = catalogVersion_example; // String | Catalog version identifier
$customizationCode = customizationCode_example; // String | Customization identifier
$variationCode = variationCode_example; // String | Variation identifier
$fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)

try {
    $api_instance->getVariation($catalog, $catalogVersion, $customizationCode, $variationCode, $fields);
} catch (Exception $e) {
    echo 'Exception when calling VariationsApi->getVariation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VariationsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::VariationsApi->new();
my $catalog = catalog_example; # String | Catalog identifier
my $catalogVersion = catalogVersion_example; # String | Catalog version identifier
my $customizationCode = customizationCode_example; # String | Customization identifier
my $variationCode = variationCode_example; # String | Variation identifier
my $fields = fields_example; # String | Response configuration (list of fields, which should be returned in response)

eval { 
    $api_instance->getVariation(catalog => $catalog, catalogVersion => $catalogVersion, customizationCode => $customizationCode, variationCode => $variationCode, fields => $fields);
};
if ($@) {
    warn "Exception when calling VariationsApi->getVariation: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.VariationsApi()
catalog = catalog_example # String | Catalog identifier
catalogVersion = catalogVersion_example # String | Catalog version identifier
customizationCode = customizationCode_example # String | Customization identifier
variationCode = variationCode_example # String | Variation identifier
fields = fields_example # String | Response configuration (list of fields, which should be returned in response) (optional)

try: 
    # Returns an existing variation
    api_instance.get_variation(catalog, catalogVersion, customizationCode, variationCode, fields=fields)
except ApiException as e:
    print("Exception when calling VariationsApi->getVariation: %s\n" % e)

Parameters

Path parameters
Name Description
catalog*
String
Catalog identifier
Required
catalogVersion*
String
Catalog version identifier
Required
customizationCode*
String
Customization identifier
Required
variationCode*
String
Variation identifier
Required
Query parameters
Name Description
fields
String
Response configuration (list of fields, which should be returned in response)

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method or catalog with given id

Status: 404 - Catalog, customization or variation with given id doesn't exist


getVariations

Returns all variations for a given customization


/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/personalizationwebservices/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VariationsApi;

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

public class VariationsApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        VariationsApi apiInstance = new VariationsApi();
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
        try {
            apiInstance.getVariations(catalog, catalogVersion, customizationCode, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling VariationsApi#getVariations");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VariationsApi;

public class VariationsApiExample {

    public static void main(String[] args) {
        VariationsApi apiInstance = new VariationsApi();
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
        try {
            apiInstance.getVariations(catalog, catalogVersion, customizationCode, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling VariationsApi#getVariations");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *catalog = catalog_example; // Catalog identifier
String *catalogVersion = catalogVersion_example; // Catalog version identifier
String *customizationCode = customizationCode_example; // Customization identifier
String *fields = fields_example; // Response configuration (list of fields, which should be returned in response) (optional)

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

// Returns all variations for a given customization
[apiInstance getVariationsWith:catalog
    catalogVersion:catalogVersion
    customizationCode:customizationCode
    fields:fields
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.VariationsApi()
var catalog = catalog_example; // {{String}} Catalog identifier
var catalogVersion = catalogVersion_example; // {{String}} Catalog version identifier
var customizationCode = customizationCode_example; // {{String}} Customization identifier
var opts = { 
  'fields': fields_example // {{String}} Response configuration (list of fields, which should be returned in response)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getVariations(catalog, catalogVersion, customizationCode, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new VariationsApi();
            var catalog = catalog_example;  // String | Catalog identifier
            var catalogVersion = catalogVersion_example;  // String | Catalog version identifier
            var customizationCode = customizationCode_example;  // String | Customization identifier
            var fields = fields_example;  // String | Response configuration (list of fields, which should be returned in response) (optional) 

            try
            {
                // Returns all variations for a given customization
                apiInstance.getVariations(catalog, catalogVersion, customizationCode, fields);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VariationsApi.getVariations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiVariationsApi();
$catalog = catalog_example; // String | Catalog identifier
$catalogVersion = catalogVersion_example; // String | Catalog version identifier
$customizationCode = customizationCode_example; // String | Customization identifier
$fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)

try {
    $api_instance->getVariations($catalog, $catalogVersion, $customizationCode, $fields);
} catch (Exception $e) {
    echo 'Exception when calling VariationsApi->getVariations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VariationsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::VariationsApi->new();
my $catalog = catalog_example; # String | Catalog identifier
my $catalogVersion = catalogVersion_example; # String | Catalog version identifier
my $customizationCode = customizationCode_example; # String | Customization identifier
my $fields = fields_example; # String | Response configuration (list of fields, which should be returned in response)

eval { 
    $api_instance->getVariations(catalog => $catalog, catalogVersion => $catalogVersion, customizationCode => $customizationCode, fields => $fields);
};
if ($@) {
    warn "Exception when calling VariationsApi->getVariations: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.VariationsApi()
catalog = catalog_example # String | Catalog identifier
catalogVersion = catalogVersion_example # String | Catalog version identifier
customizationCode = customizationCode_example # String | Customization identifier
fields = fields_example # String | Response configuration (list of fields, which should be returned in response) (optional)

try: 
    # Returns all variations for a given customization
    api_instance.get_variations(catalog, catalogVersion, customizationCode, fields=fields)
except ApiException as e:
    print("Exception when calling VariationsApi->getVariations: %s\n" % e)

Parameters

Path parameters
Name Description
catalog*
String
Catalog identifier
Required
catalogVersion*
String
Catalog version identifier
Required
customizationCode*
String
Customization identifier
Required
Query parameters
Name Description
fields
String
Response configuration (list of fields, which should be returned in response)

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method or catalog with given id

Status: 404 - Catalog or customization with given id doesn't exist


updateVariation

Updates an existing variation


/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/personalizationwebservices/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VariationsApi;

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

public class VariationsApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        VariationsApi apiInstance = new VariationsApi();
        Variation body = ; // Variation | 
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String variationCode = variationCode_example; // String | Variation identifier
        try {
            apiInstance.updateVariation(body, catalog, catalogVersion, customizationCode, variationCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling VariationsApi#updateVariation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VariationsApi;

public class VariationsApiExample {

    public static void main(String[] args) {
        VariationsApi apiInstance = new VariationsApi();
        Variation body = ; // Variation | 
        String catalog = catalog_example; // String | Catalog identifier
        String catalogVersion = catalogVersion_example; // String | Catalog version identifier
        String customizationCode = customizationCode_example; // String | Customization identifier
        String variationCode = variationCode_example; // String | Variation identifier
        try {
            apiInstance.updateVariation(body, catalog, catalogVersion, customizationCode, variationCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling VariationsApi#updateVariation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Variation *body = ; // 
String *catalog = catalog_example; // Catalog identifier
String *catalogVersion = catalogVersion_example; // Catalog version identifier
String *customizationCode = customizationCode_example; // Customization identifier
String *variationCode = variationCode_example; // Variation identifier

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

// Updates an existing variation
[apiInstance updateVariationWith:body
    catalog:catalog
    catalogVersion:catalogVersion
    customizationCode:customizationCode
    variationCode:variationCode
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalizationWebservices = require('personalization_webservices');
var defaultClient = PersonalizationWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PersonalizationWebservices.VariationsApi()
var body = ; // {{Variation}} 
var catalog = catalog_example; // {{String}} Catalog identifier
var catalogVersion = catalogVersion_example; // {{String}} Catalog version identifier
var customizationCode = customizationCode_example; // {{String}} Customization identifier
var variationCode = variationCode_example; // {{String}} Variation identifier

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new VariationsApi();
            var body = new Variation(); // Variation | 
            var catalog = catalog_example;  // String | Catalog identifier
            var catalogVersion = catalogVersion_example;  // String | Catalog version identifier
            var customizationCode = customizationCode_example;  // String | Customization identifier
            var variationCode = variationCode_example;  // String | Variation identifier

            try
            {
                // Updates an existing variation
                apiInstance.updateVariation(body, catalog, catalogVersion, customizationCode, variationCode);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VariationsApi.updateVariation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiVariationsApi();
$body = ; // Variation | 
$catalog = catalog_example; // String | Catalog identifier
$catalogVersion = catalogVersion_example; // String | Catalog version identifier
$customizationCode = customizationCode_example; // String | Customization identifier
$variationCode = variationCode_example; // String | Variation identifier

try {
    $api_instance->updateVariation($body, $catalog, $catalogVersion, $customizationCode, $variationCode);
} catch (Exception $e) {
    echo 'Exception when calling VariationsApi->updateVariation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VariationsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::VariationsApi->new();
my $body = WWW::SwaggerClient::Object::Variation->new(); # Variation | 
my $catalog = catalog_example; # String | Catalog identifier
my $catalogVersion = catalogVersion_example; # String | Catalog version identifier
my $customizationCode = customizationCode_example; # String | Customization identifier
my $variationCode = variationCode_example; # String | Variation identifier

eval { 
    $api_instance->updateVariation(body => $body, catalog => $catalog, catalogVersion => $catalogVersion, customizationCode => $customizationCode, variationCode => $variationCode);
};
if ($@) {
    warn "Exception when calling VariationsApi->updateVariation: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.VariationsApi()
body =  # Variation | 
catalog = catalog_example # String | Catalog identifier
catalogVersion = catalogVersion_example # String | Catalog version identifier
customizationCode = customizationCode_example # String | Customization identifier
variationCode = variationCode_example # String | Variation identifier

try: 
    # Updates an existing variation
    api_instance.update_variation(body, catalog, catalogVersion, customizationCode, variationCode)
except ApiException as e:
    print("Exception when calling VariationsApi->updateVariation: %s\n" % e)

Parameters

Path parameters
Name Description
catalog*
String
Catalog identifier
Required
catalogVersion*
String
Catalog version identifier
Required
customizationCode*
String
Customization identifier
Required
variationCode*
String
Variation identifier
Required
Body parameters
Name Description
body *

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method or catalog with given id

Status: 404 - Catalog, customization or variation with given id doesn't exist

Status: 409 - Conflict - variation code in request body and url do not match