Merchandising Webservices

Strategies

getStrategies

List available strategies

Retrieves a list of configured strategy objects from CDS Strategy Service.


/v1/{siteId}/strategies

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json,application/xml"\
"http://localhost:9001/merchandisingcmswebservices/v1/{siteId}/strategies?currentPage=&pageSize="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StrategiesApi;

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

public class StrategiesApiExample {

    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");

        StrategiesApi apiInstance = new StrategiesApi();
        String siteId = siteId_example; // String | Base site identifier
        String currentPage = currentPage_example; // String | Current page number
        String pageSize = pageSize_example; // String | Page size
        try {
            StrategyList result = apiInstance.getStrategies(siteId, currentPage, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StrategiesApi#getStrategies");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StrategiesApi;

public class StrategiesApiExample {

    public static void main(String[] args) {
        StrategiesApi apiInstance = new StrategiesApi();
        String siteId = siteId_example; // String | Base site identifier
        String currentPage = currentPage_example; // String | Current page number
        String pageSize = pageSize_example; // String | Page size
        try {
            StrategyList result = apiInstance.getStrategies(siteId, currentPage, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StrategiesApi#getStrategies");
            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 *siteId = siteId_example; // Base site identifier
String *currentPage = currentPage_example; // Current page number (optional) (default to 0)
String *pageSize = pageSize_example; // Page size (optional) (default to 10)

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

// List available strategies
[apiInstance getStrategiesWith:siteId
    currentPage:currentPage
    pageSize:pageSize
              completionHandler: ^(StrategyList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MerchandisingWebservices = require('merchandising_webservices');
var defaultClient = MerchandisingWebservices.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 MerchandisingWebservices.StrategiesApi()
var siteId = siteId_example; // {{String}} Base site identifier
var opts = { 
  'currentPage': currentPage_example, // {{String}} Current page number
  'pageSize': pageSize_example // {{String}} Page size
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getStrategies(siteId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getStrategiesExample
    {
        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 StrategiesApi();
            var siteId = siteId_example;  // String | Base site identifier
            var currentPage = currentPage_example;  // String | Current page number (optional)  (default to 0)
            var pageSize = pageSize_example;  // String | Page size (optional)  (default to 10)

            try
            {
                // List available strategies
                StrategyList result = apiInstance.getStrategies(siteId, currentPage, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StrategiesApi.getStrategies: " + 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\ApiStrategiesApi();
$siteId = siteId_example; // String | Base site identifier
$currentPage = currentPage_example; // String | Current page number
$pageSize = pageSize_example; // String | Page size

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

# 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::StrategiesApi->new();
my $siteId = siteId_example; # String | Base site identifier
my $currentPage = currentPage_example; # String | Current page number
my $pageSize = pageSize_example; # String | Page size

eval { 
    my $result = $api_instance->getStrategies(siteId => $siteId, currentPage => $currentPage, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StrategiesApi->getStrategies: $@\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.StrategiesApi()
siteId = siteId_example # String | Base site identifier
currentPage = currentPage_example # String | Current page number (optional) (default to 0)
pageSize = pageSize_example # String | Page size (optional) (default to 10)

try: 
    # List available strategies
    api_response = api_instance.get_strategies(siteId, currentPage=currentPage, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StrategiesApi->getStrategies: %s\n" % e)

Parameters

Path parameters
Name Description
siteId*
String
Base site identifier
Required
Query parameters
Name Description
currentPage
String
Current page number
pageSize
String
Page size

Responses

Status: 200 - List of strategy objects

Status: 400 - Bad Request

Status: 401 - Unauthorized

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

Status: 404 - Not Found


getStrategy

Get Strategy details.

Retrieves information about strategy from CDS Strategy Service.


/v1/{siteId}/strategies/{id}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json"\
"http://localhost:9001/merchandisingcmswebservices/v1/{siteId}/strategies/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StrategiesApi;

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

public class StrategiesApiExample {

    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");

        StrategiesApi apiInstance = new StrategiesApi();
        String id = id_example; // String | Strategy identifier
        String siteId = siteId_example; // String | Base site identifier
        try {
            strategy result = apiInstance.getStrategy(id, siteId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StrategiesApi#getStrategy");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StrategiesApi;

public class StrategiesApiExample {

    public static void main(String[] args) {
        StrategiesApi apiInstance = new StrategiesApi();
        String id = id_example; // String | Strategy identifier
        String siteId = siteId_example; // String | Base site identifier
        try {
            strategy result = apiInstance.getStrategy(id, siteId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StrategiesApi#getStrategy");
            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 *id = id_example; // Strategy identifier
String *siteId = siteId_example; // Base site identifier

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

// Get Strategy details.
[apiInstance getStrategyWith:id
    siteId:siteId
              completionHandler: ^(strategy output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MerchandisingWebservices = require('merchandising_webservices');
var defaultClient = MerchandisingWebservices.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 MerchandisingWebservices.StrategiesApi()
var id = id_example; // {{String}} Strategy identifier
var siteId = siteId_example; // {{String}} Base site identifier

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

namespace Example
{
    public class getStrategyExample
    {
        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 StrategiesApi();
            var id = id_example;  // String | Strategy identifier
            var siteId = siteId_example;  // String | Base site identifier

            try
            {
                // Get Strategy details.
                strategy result = apiInstance.getStrategy(id, siteId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StrategiesApi.getStrategy: " + 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\ApiStrategiesApi();
$id = id_example; // String | Strategy identifier
$siteId = siteId_example; // String | Base site identifier

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

# 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::StrategiesApi->new();
my $id = id_example; # String | Strategy identifier
my $siteId = siteId_example; # String | Base site identifier

eval { 
    my $result = $api_instance->getStrategy(id => $id, siteId => $siteId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StrategiesApi->getStrategy: $@\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.StrategiesApi()
id = id_example # String | Strategy identifier
siteId = siteId_example # String | Base site identifier

try: 
    # Get Strategy details.
    api_response = api_instance.get_strategy(id, siteId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StrategiesApi->getStrategy: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Strategy identifier
Required
siteId*
String
Base site identifier
Required

Responses

Status: 200 - Information about strategy

Status: 400 - Bad Request

Status: 401 - Unauthorized

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

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