CMS SmartEdit Webservices

Catalogs

getContentCatalogs

Get content catalogs

Endpoint to retrieve content catalog information including the related catalog versions for all catalogs for a given site and its parents.


/v1/sites/{baseSiteId}/contentcatalogs

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmssmarteditwebservices/v1/sites/{baseSiteId}/contentcatalogs"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CatalogsApi;

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

public class CatalogsApiExample {

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

        CatalogsApi apiInstance = new CatalogsApi();
        String baseSiteId = baseSiteId_example; // String | The site identifier
        try {
            CatalogList result = apiInstance.getContentCatalogs(baseSiteId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CatalogsApi#getContentCatalogs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CatalogsApi;

public class CatalogsApiExample {

    public static void main(String[] args) {
        CatalogsApi apiInstance = new CatalogsApi();
        String baseSiteId = baseSiteId_example; // String | The site identifier
        try {
            CatalogList result = apiInstance.getContentCatalogs(baseSiteId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CatalogsApi#getContentCatalogs");
            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 *baseSiteId = baseSiteId_example; // The site identifier

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

// Get content catalogs
[apiInstance getContentCatalogsWith:baseSiteId
              completionHandler: ^(CatalogList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsSmartEditWebservices = require('cms_smart_edit_webservices');
var defaultClient = CmsSmartEditWebservices.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 CmsSmartEditWebservices.CatalogsApi()
var baseSiteId = baseSiteId_example; // {{String}} The site identifier

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

namespace Example
{
    public class getContentCatalogsExample
    {
        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 CatalogsApi();
            var baseSiteId = baseSiteId_example;  // String | The site identifier

            try
            {
                // Get content catalogs
                CatalogList result = apiInstance.getContentCatalogs(baseSiteId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CatalogsApi.getContentCatalogs: " + 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\ApiCatalogsApi();
$baseSiteId = baseSiteId_example; // String | The site identifier

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

# 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::CatalogsApi->new();
my $baseSiteId = baseSiteId_example; # String | The site identifier

eval { 
    my $result = $api_instance->getContentCatalogs(baseSiteId => $baseSiteId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CatalogsApi->getContentCatalogs: $@\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.CatalogsApi()
baseSiteId = baseSiteId_example # String | The site identifier

try: 
    # Get content catalogs
    api_response = api_instance.get_content_catalogs(baseSiteId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CatalogsApi->getContentCatalogs: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
The site identifier
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getProductCatalogs

Get product catalogs

Endpoint to retrieve product catalog information including the related catalog versions for all catalogs for a given site


/v1/sites/{baseSiteId}/productcatalogs

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmssmarteditwebservices/v1/sites/{baseSiteId}/productcatalogs"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CatalogsApi;

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

public class CatalogsApiExample {

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

        CatalogsApi apiInstance = new CatalogsApi();
        String baseSiteId = baseSiteId_example; // String | The site identifier
        try {
            CatalogList result = apiInstance.getProductCatalogs(baseSiteId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CatalogsApi#getProductCatalogs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CatalogsApi;

public class CatalogsApiExample {

    public static void main(String[] args) {
        CatalogsApi apiInstance = new CatalogsApi();
        String baseSiteId = baseSiteId_example; // String | The site identifier
        try {
            CatalogList result = apiInstance.getProductCatalogs(baseSiteId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CatalogsApi#getProductCatalogs");
            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 *baseSiteId = baseSiteId_example; // The site identifier

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

// Get product catalogs
[apiInstance getProductCatalogsWith:baseSiteId
              completionHandler: ^(CatalogList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsSmartEditWebservices = require('cms_smart_edit_webservices');
var defaultClient = CmsSmartEditWebservices.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 CmsSmartEditWebservices.CatalogsApi()
var baseSiteId = baseSiteId_example; // {{String}} The site identifier

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

namespace Example
{
    public class getProductCatalogsExample
    {
        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 CatalogsApi();
            var baseSiteId = baseSiteId_example;  // String | The site identifier

            try
            {
                // Get product catalogs
                CatalogList result = apiInstance.getProductCatalogs(baseSiteId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CatalogsApi.getProductCatalogs: " + 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\ApiCatalogsApi();
$baseSiteId = baseSiteId_example; // String | The site identifier

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

# 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::CatalogsApi->new();
my $baseSiteId = baseSiteId_example; # String | The site identifier

eval { 
    my $result = $api_instance->getProductCatalogs(baseSiteId => $baseSiteId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CatalogsApi->getProductCatalogs: $@\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.CatalogsApi()
baseSiteId = baseSiteId_example # String | The site identifier

try: 
    # Get product catalogs
    api_response = api_instance.get_product_catalogs(baseSiteId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CatalogsApi->getProductCatalogs: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
The site identifier
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


Categories

getCategoryByCode

Get category by code (uuid)

Endpoint to retrieve a category that matches the given product category code uuid.


/v1/sites/{baseSiteId}/categories/{code}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmssmarteditwebservices/v1/sites/{baseSiteId}/categories/{code}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CategoriesApi;

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

public class CategoriesApiExample {

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

        CategoriesApi apiInstance = new CategoriesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String code = code_example; // String | Category code (uuid)
        try {
            Category result = apiInstance.getCategoryByCode(baseSiteId, code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CategoriesApi#getCategoryByCode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CategoriesApi;

public class CategoriesApiExample {

    public static void main(String[] args) {
        CategoriesApi apiInstance = new CategoriesApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String code = code_example; // String | Category code (uuid)
        try {
            Category result = apiInstance.getCategoryByCode(baseSiteId, code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CategoriesApi#getCategoryByCode");
            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 *baseSiteId = baseSiteId_example; // Base site identifier
String *code = code_example; // Category code (uuid)

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

// Get category by code (uuid)
[apiInstance getCategoryByCodeWith:baseSiteId
    code:code
              completionHandler: ^(Category output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsSmartEditWebservices = require('cms_smart_edit_webservices');
var defaultClient = CmsSmartEditWebservices.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 CmsSmartEditWebservices.CategoriesApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var code = code_example; // {{String}} Category code (uuid)

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

namespace Example
{
    public class getCategoryByCodeExample
    {
        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 CategoriesApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var code = code_example;  // String | Category code (uuid)

            try
            {
                // Get category by code (uuid)
                Category result = apiInstance.getCategoryByCode(baseSiteId, code);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CategoriesApi.getCategoryByCode: " + 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\ApiCategoriesApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$code = code_example; // String | Category code (uuid)

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

# 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::CategoriesApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $code = code_example; # String | Category code (uuid)

eval { 
    my $result = $api_instance->getCategoryByCode(baseSiteId => $baseSiteId, code => $code);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CategoriesApi->getCategoryByCode: $@\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.CategoriesApi()
baseSiteId = baseSiteId_example # String | Base site identifier
code = code_example # String | Category code (uuid)

try: 
    # Get category by code (uuid)
    api_response = api_instance.get_category_by_code(baseSiteId, code)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CategoriesApi->getCategoryByCode: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
code*
String
Category code (uuid)
Required

Responses

Status: 200 - Category data

Status: 400 - When the item has not been found (CMSItemNotFoundException) or when there was problem during conversion (ConversionException).

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getProductCategoriesByTextOrMask

Find product categories by text or mask

Endpoint to find product categories using a free text search field.


/v1/productcatalogs/{catalogId}/versions/{versionId}/categories

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmssmarteditwebservices/v1/productcatalogs/{catalogId}/versions/{versionId}/categories?currentPage=&langIsoCode=&mask=&pageSize=&pageableDto=&sort=&text="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CategoriesApi;

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

public class CategoriesApiExample {

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

        CategoriesApi apiInstance = new CategoriesApi();
        String catalogId = catalogId_example; // String | The uid of the catalog
        Pageable pageableDto = ; // Pageable | 
        String versionId = versionId_example; // String | The uid of the catalog version
        String currentPage = currentPage_example; // String | The requested page number
        String langIsoCode = langIsoCode_example; // String | The language iso code used to filter products
        String mask = mask_example; // String | The string value on which products will be filtered if no text value is provided
        String pageSize = pageSize_example; // String | The maximum number of elements in the result list.
        String sort = sort_example; // String | The string field the results will be sorted with
        String text = text_example; // String | The string value on which products will be filtered
        try {
            CategorySearchResult result = apiInstance.getProductCategoriesByTextOrMask(catalogId, pageableDto, versionId, currentPage, langIsoCode, mask, pageSize, sort, text);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CategoriesApi#getProductCategoriesByTextOrMask");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CategoriesApi;

public class CategoriesApiExample {

    public static void main(String[] args) {
        CategoriesApi apiInstance = new CategoriesApi();
        String catalogId = catalogId_example; // String | The uid of the catalog
        Pageable pageableDto = ; // Pageable | 
        String versionId = versionId_example; // String | The uid of the catalog version
        String currentPage = currentPage_example; // String | The requested page number
        String langIsoCode = langIsoCode_example; // String | The language iso code used to filter products
        String mask = mask_example; // String | The string value on which products will be filtered if no text value is provided
        String pageSize = pageSize_example; // String | The maximum number of elements in the result list.
        String sort = sort_example; // String | The string field the results will be sorted with
        String text = text_example; // String | The string value on which products will be filtered
        try {
            CategorySearchResult result = apiInstance.getProductCategoriesByTextOrMask(catalogId, pageableDto, versionId, currentPage, langIsoCode, mask, pageSize, sort, text);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CategoriesApi#getProductCategoriesByTextOrMask");
            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 *catalogId = catalogId_example; // The uid of the catalog
Pageable *pageableDto = ; // 
String *versionId = versionId_example; // The uid of the catalog version
String *currentPage = currentPage_example; // The requested page number (optional) (default to 0)
String *langIsoCode = langIsoCode_example; // The language iso code used to filter products (optional)
String *mask = mask_example; // The string value on which products will be filtered if no text value is provided (optional)
String *pageSize = pageSize_example; // The maximum number of elements in the result list. (optional) (default to 10)
String *sort = sort_example; // The string field the results will be sorted with (optional)
String *text = text_example; // The string value on which products will be filtered (optional)

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

// Find product categories by text or mask
[apiInstance getProductCategoriesByTextOrMaskWith:catalogId
    pageableDto:pageableDto
    versionId:versionId
    currentPage:currentPage
    langIsoCode:langIsoCode
    mask:mask
    pageSize:pageSize
    sort:sort
    text:text
              completionHandler: ^(CategorySearchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsSmartEditWebservices = require('cms_smart_edit_webservices');
var defaultClient = CmsSmartEditWebservices.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 CmsSmartEditWebservices.CategoriesApi()
var catalogId = catalogId_example; // {{String}} The uid of the catalog
var pageableDto = ; // {{Pageable}} 
var versionId = versionId_example; // {{String}} The uid of the catalog version
var opts = { 
  'currentPage': currentPage_example, // {{String}} The requested page number
  'langIsoCode': langIsoCode_example, // {{String}} The language iso code used to filter products
  'mask': mask_example, // {{String}} The string value on which products will be filtered if no text value is provided
  'pageSize': pageSize_example, // {{String}} The maximum number of elements in the result list.
  'sort': sort_example, // {{String}} The string field the results will be sorted with
  'text': text_example // {{String}} The string value on which products will be filtered
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProductCategoriesByTextOrMask(catalogId, pageableDto, versionId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProductCategoriesByTextOrMaskExample
    {
        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 CategoriesApi();
            var catalogId = catalogId_example;  // String | The uid of the catalog
            var pageableDto = new Pageable(); // Pageable | 
            var versionId = versionId_example;  // String | The uid of the catalog version
            var currentPage = currentPage_example;  // String | The requested page number (optional)  (default to 0)
            var langIsoCode = langIsoCode_example;  // String | The language iso code used to filter products (optional) 
            var mask = mask_example;  // String | The string value on which products will be filtered if no text value is provided (optional) 
            var pageSize = pageSize_example;  // String | The maximum number of elements in the result list. (optional)  (default to 10)
            var sort = sort_example;  // String | The string field the results will be sorted with (optional) 
            var text = text_example;  // String | The string value on which products will be filtered (optional) 

            try
            {
                // Find product categories by text or mask
                CategorySearchResult result = apiInstance.getProductCategoriesByTextOrMask(catalogId, pageableDto, versionId, currentPage, langIsoCode, mask, pageSize, sort, text);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CategoriesApi.getProductCategoriesByTextOrMask: " + 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\ApiCategoriesApi();
$catalogId = catalogId_example; // String | The uid of the catalog
$pageableDto = ; // Pageable | 
$versionId = versionId_example; // String | The uid of the catalog version
$currentPage = currentPage_example; // String | The requested page number
$langIsoCode = langIsoCode_example; // String | The language iso code used to filter products
$mask = mask_example; // String | The string value on which products will be filtered if no text value is provided
$pageSize = pageSize_example; // String | The maximum number of elements in the result list.
$sort = sort_example; // String | The string field the results will be sorted with
$text = text_example; // String | The string value on which products will be filtered

try {
    $result = $api_instance->getProductCategoriesByTextOrMask($catalogId, $pageableDto, $versionId, $currentPage, $langIsoCode, $mask, $pageSize, $sort, $text);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CategoriesApi->getProductCategoriesByTextOrMask: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CategoriesApi;

# 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::CategoriesApi->new();
my $catalogId = catalogId_example; # String | The uid of the catalog
my $pageableDto = ; # Pageable | 
my $versionId = versionId_example; # String | The uid of the catalog version
my $currentPage = currentPage_example; # String | The requested page number
my $langIsoCode = langIsoCode_example; # String | The language iso code used to filter products
my $mask = mask_example; # String | The string value on which products will be filtered if no text value is provided
my $pageSize = pageSize_example; # String | The maximum number of elements in the result list.
my $sort = sort_example; # String | The string field the results will be sorted with
my $text = text_example; # String | The string value on which products will be filtered

eval { 
    my $result = $api_instance->getProductCategoriesByTextOrMask(catalogId => $catalogId, pageableDto => $pageableDto, versionId => $versionId, currentPage => $currentPage, langIsoCode => $langIsoCode, mask => $mask, pageSize => $pageSize, sort => $sort, text => $text);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CategoriesApi->getProductCategoriesByTextOrMask: $@\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.CategoriesApi()
catalogId = catalogId_example # String | The uid of the catalog
pageableDto =  # Pageable | 
versionId = versionId_example # String | The uid of the catalog version
currentPage = currentPage_example # String | The requested page number (optional) (default to 0)
langIsoCode = langIsoCode_example # String | The language iso code used to filter products (optional)
mask = mask_example # String | The string value on which products will be filtered if no text value is provided (optional)
pageSize = pageSize_example # String | The maximum number of elements in the result list. (optional) (default to 10)
sort = sort_example # String | The string field the results will be sorted with (optional)
text = text_example # String | The string value on which products will be filtered (optional)

try: 
    # Find product categories by text or mask
    api_response = api_instance.get_product_categories_by_text_or_mask(catalogId, pageableDto, versionId, currentPage=currentPage, langIsoCode=langIsoCode, mask=mask, pageSize=pageSize, sort=sort, text=text)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CategoriesApi->getProductCategoriesByTextOrMask: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The uid of the catalog
Required
versionId*
String
The uid of the catalog version
Required
Query parameters
Name Description
currentPage
String
The requested page number
langIsoCode
String
The language iso code used to filter products
mask
String
The string value on which products will be filtered if no text value is provided
pageSize
String
The maximum number of elements in the result list.
pageableDto*
Pageable
Required
sort
String
The string field the results will be sorted with
text
String
The string value on which products will be filtered

Responses

Status: 200 - DTO which serves as a wrapper object that contains a list of CategoryData, never null

Status: 400 - Bad Request e.g. incorrect parameter value

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


Inbox

getWorkFlowTasks

Retrieves all workflow tasks for the current user that are yet to be acted upon

Endpoint that retrieves all workflow tasks for the current user


/v1/inbox/workflowtasks

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmssmarteditwebservices/v1/inbox/workflowtasks?currentPage=&pageSize=&pageableDto=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InboxApi;

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

public class InboxApiExample {

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

        InboxApi apiInstance = new InboxApi();
        Pageable pageableDto = ; // Pageable | 
        String currentPage = currentPage_example; // String | The requested page number
        String pageSize = pageSize_example; // String | The maximum number of elements in the result list.
        String sort = sort_example; // String | The string field the results will be sorted with
        try {
            CMSWorkflowTaskList result = apiInstance.getWorkFlowTasks(pageableDto, currentPage, pageSize, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InboxApi#getWorkFlowTasks");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InboxApi;

public class InboxApiExample {

    public static void main(String[] args) {
        InboxApi apiInstance = new InboxApi();
        Pageable pageableDto = ; // Pageable | 
        String currentPage = currentPage_example; // String | The requested page number
        String pageSize = pageSize_example; // String | The maximum number of elements in the result list.
        String sort = sort_example; // String | The string field the results will be sorted with
        try {
            CMSWorkflowTaskList result = apiInstance.getWorkFlowTasks(pageableDto, currentPage, pageSize, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InboxApi#getWorkFlowTasks");
            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"];
Pageable *pageableDto = ; // 
String *currentPage = currentPage_example; // The requested page number (optional) (default to 0)
String *pageSize = pageSize_example; // The maximum number of elements in the result list. (optional) (default to 10)
String *sort = sort_example; // The string field the results will be sorted with (optional)

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

// Retrieves all workflow tasks for the current user that are yet to be acted upon
[apiInstance getWorkFlowTasksWith:pageableDto
    currentPage:currentPage
    pageSize:pageSize
    sort:sort
              completionHandler: ^(CMSWorkflowTaskList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsSmartEditWebservices = require('cms_smart_edit_webservices');
var defaultClient = CmsSmartEditWebservices.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 CmsSmartEditWebservices.InboxApi()
var pageableDto = ; // {{Pageable}} 
var opts = { 
  'currentPage': currentPage_example, // {{String}} The requested page number
  'pageSize': pageSize_example, // {{String}} The maximum number of elements in the result list.
  'sort': sort_example // {{String}} The string field the results will be sorted with
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWorkFlowTasks(pageableDto, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getWorkFlowTasksExample
    {
        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 InboxApi();
            var pageableDto = new Pageable(); // Pageable | 
            var currentPage = currentPage_example;  // String | The requested page number (optional)  (default to 0)
            var pageSize = pageSize_example;  // String | The maximum number of elements in the result list. (optional)  (default to 10)
            var sort = sort_example;  // String | The string field the results will be sorted with (optional) 

            try
            {
                // Retrieves all workflow tasks for the current user that are yet to be acted upon
                CMSWorkflowTaskList result = apiInstance.getWorkFlowTasks(pageableDto, currentPage, pageSize, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InboxApi.getWorkFlowTasks: " + 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\ApiInboxApi();
$pageableDto = ; // Pageable | 
$currentPage = currentPage_example; // String | The requested page number
$pageSize = pageSize_example; // String | The maximum number of elements in the result list.
$sort = sort_example; // String | The string field the results will be sorted with

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

# 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::InboxApi->new();
my $pageableDto = ; # Pageable | 
my $currentPage = currentPage_example; # String | The requested page number
my $pageSize = pageSize_example; # String | The maximum number of elements in the result list.
my $sort = sort_example; # String | The string field the results will be sorted with

eval { 
    my $result = $api_instance->getWorkFlowTasks(pageableDto => $pageableDto, currentPage => $currentPage, pageSize => $pageSize, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InboxApi->getWorkFlowTasks: $@\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.InboxApi()
pageableDto =  # Pageable | 
currentPage = currentPage_example # String | The requested page number (optional) (default to 0)
pageSize = pageSize_example # String | The maximum number of elements in the result list. (optional) (default to 10)
sort = sort_example # String | The string field the results will be sorted with (optional)

try: 
    # Retrieves all workflow tasks for the current user that are yet to be acted upon
    api_response = api_instance.get_work_flow_tasks(pageableDto, currentPage=currentPage, pageSize=pageSize, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InboxApi->getWorkFlowTasks: %s\n" % e)

Parameters

Query parameters
Name Description
currentPage
String
The requested page number
pageSize
String
The maximum number of elements in the result list.
pageableDto*
Pageable
Required
sort
String
The string field the results will be sorted with

Responses

Status: 200 - The dto containing the workflow tasks

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


PageComponentTypes

getComponentTypesAvailableToPage

Retrieves component types.

Retrieves the component types that can be added to a page.


/v1/catalogs/{catalogId}/versions/{versionId}/pages/{pageId}/types

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmssmarteditwebservices/v1/catalogs/{catalogId}/versions/{versionId}/pages/{pageId}/types?componentTypesForPageSearchWsDTO=¤tPage=&fields=&langIsoCode=&mask=&pageSize=&pageableInfo=&readOnly="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PageComponentTypesApi;

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

public class PageComponentTypesApiExample {

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

        PageComponentTypesApi apiInstance = new PageComponentTypesApi();
        String catalogId = catalogId_example; // String | The catalog id
        CMSComponentTypesForPageSearch componentTypesForPageSearchWsDTO = ; // CMSComponentTypesForPageSearch | Component Types For Page Search DTO
        String pageId = pageId_example; // String | The uid of the page for which to find its valid component types
        String pageSize = pageSize_example; // String | Page size for paging
        Pageable pageableInfo = ; // Pageable | Pageable DTO
        String versionId = versionId_example; // String | The uid of the catalog version
        String currentPage = currentPage_example; // String | The requested page number
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
        String langIsoCode = langIsoCode_example; // String | language ISO Code
        String mask = mask_example; // String | Search mask applied to the type code and name fields, Uses partial matching
        Boolean readOnly = true; // Boolean | Read only mode for attributes. Is only used if attributes are returned (FULL fields option is used) 
        try {
            CMSComponentTypeList result = apiInstance.getComponentTypesAvailableToPage(catalogId, componentTypesForPageSearchWsDTO, pageId, pageSize, pageableInfo, versionId, currentPage, fields, langIsoCode, mask, readOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageComponentTypesApi#getComponentTypesAvailableToPage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PageComponentTypesApi;

public class PageComponentTypesApiExample {

    public static void main(String[] args) {
        PageComponentTypesApi apiInstance = new PageComponentTypesApi();
        String catalogId = catalogId_example; // String | The catalog id
        CMSComponentTypesForPageSearch componentTypesForPageSearchWsDTO = ; // CMSComponentTypesForPageSearch | Component Types For Page Search DTO
        String pageId = pageId_example; // String | The uid of the page for which to find its valid component types
        String pageSize = pageSize_example; // String | Page size for paging
        Pageable pageableInfo = ; // Pageable | Pageable DTO
        String versionId = versionId_example; // String | The uid of the catalog version
        String currentPage = currentPage_example; // String | The requested page number
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
        String langIsoCode = langIsoCode_example; // String | language ISO Code
        String mask = mask_example; // String | Search mask applied to the type code and name fields, Uses partial matching
        Boolean readOnly = true; // Boolean | Read only mode for attributes. Is only used if attributes are returned (FULL fields option is used) 
        try {
            CMSComponentTypeList result = apiInstance.getComponentTypesAvailableToPage(catalogId, componentTypesForPageSearchWsDTO, pageId, pageSize, pageableInfo, versionId, currentPage, fields, langIsoCode, mask, readOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageComponentTypesApi#getComponentTypesAvailableToPage");
            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 *catalogId = catalogId_example; // The catalog id
CMSComponentTypesForPageSearch *componentTypesForPageSearchWsDTO = ; // Component Types For Page Search DTO
String *pageId = pageId_example; // The uid of the page for which to find its valid component types
String *pageSize = pageSize_example; // Page size for paging
Pageable *pageableInfo = ; // Pageable DTO
String *versionId = versionId_example; // The uid of the catalog version
String *currentPage = currentPage_example; // The requested page number (optional) (default to 0)
String *fields = fields_example; // Response configuration (list of fields, which should be returned in response) (optional)
String *langIsoCode = langIsoCode_example; // language ISO Code (optional)
String *mask = mask_example; // Search mask applied to the type code and name fields, Uses partial matching (optional)
Boolean *readOnly = true; // Read only mode for attributes. Is only used if attributes are returned (FULL fields option is used)  (optional) (default to false)

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

// Retrieves component types.
[apiInstance getComponentTypesAvailableToPageWith:catalogId
    componentTypesForPageSearchWsDTO:componentTypesForPageSearchWsDTO
    pageId:pageId
    pageSize:pageSize
    pageableInfo:pageableInfo
    versionId:versionId
    currentPage:currentPage
    fields:fields
    langIsoCode:langIsoCode
    mask:mask
    readOnly:readOnly
              completionHandler: ^(CMSComponentTypeList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsSmartEditWebservices = require('cms_smart_edit_webservices');
var defaultClient = CmsSmartEditWebservices.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 CmsSmartEditWebservices.PageComponentTypesApi()
var catalogId = catalogId_example; // {{String}} The catalog id
var componentTypesForPageSearchWsDTO = ; // {{CMSComponentTypesForPageSearch}} Component Types For Page Search DTO
var pageId = pageId_example; // {{String}} The uid of the page for which to find its valid component types
var pageSize = pageSize_example; // {{String}} Page size for paging
var pageableInfo = ; // {{Pageable}} Pageable DTO
var versionId = versionId_example; // {{String}} The uid of the catalog version
var opts = { 
  'currentPage': currentPage_example, // {{String}} The requested page number
  'fields': fields_example, // {{String}} Response configuration (list of fields, which should be returned in response)
  'langIsoCode': langIsoCode_example, // {{String}} language ISO Code
  'mask': mask_example, // {{String}} Search mask applied to the type code and name fields, Uses partial matching
  'readOnly': true // {{Boolean}} Read only mode for attributes. Is only used if attributes are returned (FULL fields option is used) 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getComponentTypesAvailableToPage(catalogId, componentTypesForPageSearchWsDTO, pageId, pageSize, pageableInfo, versionId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getComponentTypesAvailableToPageExample
    {
        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 PageComponentTypesApi();
            var catalogId = catalogId_example;  // String | The catalog id
            var componentTypesForPageSearchWsDTO = new CMSComponentTypesForPageSearch(); // CMSComponentTypesForPageSearch | Component Types For Page Search DTO
            var pageId = pageId_example;  // String | The uid of the page for which to find its valid component types
            var pageSize = pageSize_example;  // String | Page size for paging
            var pageableInfo = new Pageable(); // Pageable | Pageable DTO
            var versionId = versionId_example;  // String | The uid of the catalog version
            var currentPage = currentPage_example;  // String | The requested page number (optional)  (default to 0)
            var fields = fields_example;  // String | Response configuration (list of fields, which should be returned in response) (optional) 
            var langIsoCode = langIsoCode_example;  // String | language ISO Code (optional) 
            var mask = mask_example;  // String | Search mask applied to the type code and name fields, Uses partial matching (optional) 
            var readOnly = true;  // Boolean | Read only mode for attributes. Is only used if attributes are returned (FULL fields option is used)  (optional)  (default to false)

            try
            {
                // Retrieves component types.
                CMSComponentTypeList result = apiInstance.getComponentTypesAvailableToPage(catalogId, componentTypesForPageSearchWsDTO, pageId, pageSize, pageableInfo, versionId, currentPage, fields, langIsoCode, mask, readOnly);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PageComponentTypesApi.getComponentTypesAvailableToPage: " + 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\ApiPageComponentTypesApi();
$catalogId = catalogId_example; // String | The catalog id
$componentTypesForPageSearchWsDTO = ; // CMSComponentTypesForPageSearch | Component Types For Page Search DTO
$pageId = pageId_example; // String | The uid of the page for which to find its valid component types
$pageSize = pageSize_example; // String | Page size for paging
$pageableInfo = ; // Pageable | Pageable DTO
$versionId = versionId_example; // String | The uid of the catalog version
$currentPage = currentPage_example; // String | The requested page number
$fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
$langIsoCode = langIsoCode_example; // String | language ISO Code
$mask = mask_example; // String | Search mask applied to the type code and name fields, Uses partial matching
$readOnly = true; // Boolean | Read only mode for attributes. Is only used if attributes are returned (FULL fields option is used) 

try {
    $result = $api_instance->getComponentTypesAvailableToPage($catalogId, $componentTypesForPageSearchWsDTO, $pageId, $pageSize, $pageableInfo, $versionId, $currentPage, $fields, $langIsoCode, $mask, $readOnly);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PageComponentTypesApi->getComponentTypesAvailableToPage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PageComponentTypesApi;

# 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::PageComponentTypesApi->new();
my $catalogId = catalogId_example; # String | The catalog id
my $componentTypesForPageSearchWsDTO = ; # CMSComponentTypesForPageSearch | Component Types For Page Search DTO
my $pageId = pageId_example; # String | The uid of the page for which to find its valid component types
my $pageSize = pageSize_example; # String | Page size for paging
my $pageableInfo = ; # Pageable | Pageable DTO
my $versionId = versionId_example; # String | The uid of the catalog version
my $currentPage = currentPage_example; # String | The requested page number
my $fields = fields_example; # String | Response configuration (list of fields, which should be returned in response)
my $langIsoCode = langIsoCode_example; # String | language ISO Code
my $mask = mask_example; # String | Search mask applied to the type code and name fields, Uses partial matching
my $readOnly = true; # Boolean | Read only mode for attributes. Is only used if attributes are returned (FULL fields option is used) 

eval { 
    my $result = $api_instance->getComponentTypesAvailableToPage(catalogId => $catalogId, componentTypesForPageSearchWsDTO => $componentTypesForPageSearchWsDTO, pageId => $pageId, pageSize => $pageSize, pageableInfo => $pageableInfo, versionId => $versionId, currentPage => $currentPage, fields => $fields, langIsoCode => $langIsoCode, mask => $mask, readOnly => $readOnly);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PageComponentTypesApi->getComponentTypesAvailableToPage: $@\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.PageComponentTypesApi()
catalogId = catalogId_example # String | The catalog id
componentTypesForPageSearchWsDTO =  # CMSComponentTypesForPageSearch | Component Types For Page Search DTO
pageId = pageId_example # String | The uid of the page for which to find its valid component types
pageSize = pageSize_example # String | Page size for paging
pageableInfo =  # Pageable | Pageable DTO
versionId = versionId_example # String | The uid of the catalog version
currentPage = currentPage_example # String | The requested page number (optional) (default to 0)
fields = fields_example # String | Response configuration (list of fields, which should be returned in response) (optional)
langIsoCode = langIsoCode_example # String | language ISO Code (optional)
mask = mask_example # String | Search mask applied to the type code and name fields, Uses partial matching (optional)
readOnly = true # Boolean | Read only mode for attributes. Is only used if attributes are returned (FULL fields option is used)  (optional) (default to false)

try: 
    # Retrieves component types.
    api_response = api_instance.get_component_types_available_to_page(catalogId, componentTypesForPageSearchWsDTO, pageId, pageSize, pageableInfo, versionId, currentPage=currentPage, fields=fields, langIsoCode=langIsoCode, mask=mask, readOnly=readOnly)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PageComponentTypesApi->getComponentTypesAvailableToPage: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog id
Required
pageId*
String
The uid of the page for which to find its valid component types
Required
versionId*
String
The uid of the catalog version
Required
Query parameters
Name Description
componentTypesForPageSearchWsDTO*
CMSComponentTypesForPageSearch
Component Types For Page Search DTO
Required
currentPage
String
The requested page number
fields
String
Response configuration (list of fields, which should be returned in response)
langIsoCode
String
language ISO Code
mask
String
Search mask applied to the type code and name fields, Uses partial matching
pageSize*
String
Page size for paging
Required
pageableInfo*
Pageable
Pageable DTO
Required
readOnly
Boolean
Read only mode for attributes. Is only used if attributes are returned (FULL fields option is used)

Responses

Status: 200 - The dto containing the list of component types applicable to a page. The results are paged.

Status: 400 - If the given page cannot be found (CMSItemNotFoundException).

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


PageOperations

performPageItemOperations

Perform different operations on the page item.

Endpoint to perform different operations on the page item such as delete a page etc.


/v1/sites/{baseSiteId}/catalogs/{catalogId}/pages/{pageId}/operations

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/cmssmarteditwebservices/v1/sites/{baseSiteId}/catalogs/{catalogId}/pages/{pageId}/operations"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PageOperationsApi;

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

public class PageOperationsApiExample {

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

        PageOperationsApi apiInstance = new PageOperationsApi();
        CMSPageOperation body = ; // CMSPageOperation | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String catalogId = catalogId_example; // String | The uid of the catalog
        String pageId = pageId_example; // String | The uid of the page to be updated
        try {
            CMSPageOperation result = apiInstance.performPageItemOperations(body, baseSiteId, catalogId, pageId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageOperationsApi#performPageItemOperations");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PageOperationsApi;

public class PageOperationsApiExample {

    public static void main(String[] args) {
        PageOperationsApi apiInstance = new PageOperationsApi();
        CMSPageOperation body = ; // CMSPageOperation | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String catalogId = catalogId_example; // String | The uid of the catalog
        String pageId = pageId_example; // String | The uid of the page to be updated
        try {
            CMSPageOperation result = apiInstance.performPageItemOperations(body, baseSiteId, catalogId, pageId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageOperationsApi#performPageItemOperations");
            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"];
CMSPageOperation *body = ; // 
String *baseSiteId = baseSiteId_example; // Base site identifier
String *catalogId = catalogId_example; // The uid of the catalog
String *pageId = pageId_example; // The uid of the page to be updated

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

// Perform different operations on the page item.
[apiInstance performPageItemOperationsWith:body
    baseSiteId:baseSiteId
    catalogId:catalogId
    pageId:pageId
              completionHandler: ^(CMSPageOperation output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsSmartEditWebservices = require('cms_smart_edit_webservices');
var defaultClient = CmsSmartEditWebservices.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 CmsSmartEditWebservices.PageOperationsApi()
var body = ; // {{CMSPageOperation}} 
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var catalogId = catalogId_example; // {{String}} The uid of the catalog
var pageId = pageId_example; // {{String}} The uid of the page to be updated

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

namespace Example
{
    public class performPageItemOperationsExample
    {
        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 PageOperationsApi();
            var body = new CMSPageOperation(); // CMSPageOperation | 
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var catalogId = catalogId_example;  // String | The uid of the catalog
            var pageId = pageId_example;  // String | The uid of the page to be updated

            try
            {
                // Perform different operations on the page item.
                CMSPageOperation result = apiInstance.performPageItemOperations(body, baseSiteId, catalogId, pageId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PageOperationsApi.performPageItemOperations: " + 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\ApiPageOperationsApi();
$body = ; // CMSPageOperation | 
$baseSiteId = baseSiteId_example; // String | Base site identifier
$catalogId = catalogId_example; // String | The uid of the catalog
$pageId = pageId_example; // String | The uid of the page to be updated

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

# 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::PageOperationsApi->new();
my $body = WWW::SwaggerClient::Object::CMSPageOperation->new(); # CMSPageOperation | 
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $catalogId = catalogId_example; # String | The uid of the catalog
my $pageId = pageId_example; # String | The uid of the page to be updated

eval { 
    my $result = $api_instance->performPageItemOperations(body => $body, baseSiteId => $baseSiteId, catalogId => $catalogId, pageId => $pageId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PageOperationsApi->performPageItemOperations: $@\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.PageOperationsApi()
body =  # CMSPageOperation | 
baseSiteId = baseSiteId_example # String | Base site identifier
catalogId = catalogId_example # String | The uid of the catalog
pageId = pageId_example # String | The uid of the page to be updated

try: 
    # Perform different operations on the page item.
    api_response = api_instance.perform_page_item_operations(body, baseSiteId, catalogId, pageId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PageOperationsApi->performPageItemOperations: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
catalogId*
String
The uid of the catalog
Required
pageId*
String
The uid of the page to be updated
Required
Body parameters
Name Description
body *

Responses

Status: 200 - The page operation item.

Status: 400 - When the payload does not have the 'operation' property. (IllegalArgumentException)

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - When the item has not been found (UnknownIdentifierException)


Products

getProductByCode

Get product by code (uuid)

Endpoint to retrieve a product that matches the given product code uuid.


/v1/sites/{baseSiteId}/products/{code}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmssmarteditwebservices/v1/sites/{baseSiteId}/products/{code}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductsApi;

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

public class ProductsApiExample {

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

        ProductsApi apiInstance = new ProductsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String code = code_example; // String | Product code (uuid)
        try {
            Product result = apiInstance.getProductByCode(baseSiteId, code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getProductByCode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String code = code_example; // String | Product code (uuid)
        try {
            Product result = apiInstance.getProductByCode(baseSiteId, code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getProductByCode");
            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 *baseSiteId = baseSiteId_example; // Base site identifier
String *code = code_example; // Product code (uuid)

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

// Get product by code (uuid)
[apiInstance getProductByCodeWith:baseSiteId
    code:code
              completionHandler: ^(Product output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsSmartEditWebservices = require('cms_smart_edit_webservices');
var defaultClient = CmsSmartEditWebservices.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 CmsSmartEditWebservices.ProductsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var code = code_example; // {{String}} Product code (uuid)

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

namespace Example
{
    public class getProductByCodeExample
    {
        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 ProductsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var code = code_example;  // String | Product code (uuid)

            try
            {
                // Get product by code (uuid)
                Product result = apiInstance.getProductByCode(baseSiteId, code);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.getProductByCode: " + 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\ApiProductsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$code = code_example; // String | Product code (uuid)

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

# 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::ProductsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $code = code_example; # String | Product code (uuid)

eval { 
    my $result = $api_instance->getProductByCode(baseSiteId => $baseSiteId, code => $code);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductsApi->getProductByCode: $@\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.ProductsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
code = code_example # String | Product code (uuid)

try: 
    # Get product by code (uuid)
    api_response = api_instance.get_product_by_code(baseSiteId, code)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductsApi->getProductByCode: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
code*
String
Product code (uuid)
Required

Responses

Status: 200 - Product data

Status: 400 - When the item has not been found (CMSItemNotFoundException) or when there was problem during conversion (ConversionException).

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getProductsByTextOrMask

Find products by text or mask

Endpoint to retrieve products using a free text search field.


/v1/productcatalogs/{catalogId}/versions/{versionId}/products

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmssmarteditwebservices/v1/productcatalogs/{catalogId}/versions/{versionId}/products?currentPage=&langIsoCode=&mask=&pageSize=&pageableDto=&sort=&text="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductsApi;

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

public class ProductsApiExample {

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

        ProductsApi apiInstance = new ProductsApi();
        String catalogId = catalogId_example; // String | The uid of the catalog
        Pageable pageableDto = ; // Pageable | 
        String versionId = versionId_example; // String | The uid of the catalog version
        String currentPage = currentPage_example; // String | The requested page number
        String langIsoCode = langIsoCode_example; // String | The language iso code by which products will be filtered
        String mask = mask_example; // String | The string value on which products will be filtered if no text value is provided
        String pageSize = pageSize_example; // String | The maximum number of elements in the result list.
        String sort = sort_example; // String | The string field the results will be sorted with
        String text = text_example; // String | The string value on which products will be filtered
        try {
            ProductSearchResult result = apiInstance.getProductsByTextOrMask(catalogId, pageableDto, versionId, currentPage, langIsoCode, mask, pageSize, sort, text);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getProductsByTextOrMask");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        String catalogId = catalogId_example; // String | The uid of the catalog
        Pageable pageableDto = ; // Pageable | 
        String versionId = versionId_example; // String | The uid of the catalog version
        String currentPage = currentPage_example; // String | The requested page number
        String langIsoCode = langIsoCode_example; // String | The language iso code by which products will be filtered
        String mask = mask_example; // String | The string value on which products will be filtered if no text value is provided
        String pageSize = pageSize_example; // String | The maximum number of elements in the result list.
        String sort = sort_example; // String | The string field the results will be sorted with
        String text = text_example; // String | The string value on which products will be filtered
        try {
            ProductSearchResult result = apiInstance.getProductsByTextOrMask(catalogId, pageableDto, versionId, currentPage, langIsoCode, mask, pageSize, sort, text);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getProductsByTextOrMask");
            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 *catalogId = catalogId_example; // The uid of the catalog
Pageable *pageableDto = ; // 
String *versionId = versionId_example; // The uid of the catalog version
String *currentPage = currentPage_example; // The requested page number (optional) (default to 0)
String *langIsoCode = langIsoCode_example; // The language iso code by which products will be filtered (optional)
String *mask = mask_example; // The string value on which products will be filtered if no text value is provided (optional)
String *pageSize = pageSize_example; // The maximum number of elements in the result list. (optional) (default to 10)
String *sort = sort_example; // The string field the results will be sorted with (optional)
String *text = text_example; // The string value on which products will be filtered (optional)

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

// Find products by text or mask
[apiInstance getProductsByTextOrMaskWith:catalogId
    pageableDto:pageableDto
    versionId:versionId
    currentPage:currentPage
    langIsoCode:langIsoCode
    mask:mask
    pageSize:pageSize
    sort:sort
    text:text
              completionHandler: ^(ProductSearchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsSmartEditWebservices = require('cms_smart_edit_webservices');
var defaultClient = CmsSmartEditWebservices.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 CmsSmartEditWebservices.ProductsApi()
var catalogId = catalogId_example; // {{String}} The uid of the catalog
var pageableDto = ; // {{Pageable}} 
var versionId = versionId_example; // {{String}} The uid of the catalog version
var opts = { 
  'currentPage': currentPage_example, // {{String}} The requested page number
  'langIsoCode': langIsoCode_example, // {{String}} The language iso code by which products will be filtered
  'mask': mask_example, // {{String}} The string value on which products will be filtered if no text value is provided
  'pageSize': pageSize_example, // {{String}} The maximum number of elements in the result list.
  'sort': sort_example, // {{String}} The string field the results will be sorted with
  'text': text_example // {{String}} The string value on which products will be filtered
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProductsByTextOrMask(catalogId, pageableDto, versionId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProductsByTextOrMaskExample
    {
        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 ProductsApi();
            var catalogId = catalogId_example;  // String | The uid of the catalog
            var pageableDto = new Pageable(); // Pageable | 
            var versionId = versionId_example;  // String | The uid of the catalog version
            var currentPage = currentPage_example;  // String | The requested page number (optional)  (default to 0)
            var langIsoCode = langIsoCode_example;  // String | The language iso code by which products will be filtered (optional) 
            var mask = mask_example;  // String | The string value on which products will be filtered if no text value is provided (optional) 
            var pageSize = pageSize_example;  // String | The maximum number of elements in the result list. (optional)  (default to 10)
            var sort = sort_example;  // String | The string field the results will be sorted with (optional) 
            var text = text_example;  // String | The string value on which products will be filtered (optional) 

            try
            {
                // Find products by text or mask
                ProductSearchResult result = apiInstance.getProductsByTextOrMask(catalogId, pageableDto, versionId, currentPage, langIsoCode, mask, pageSize, sort, text);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.getProductsByTextOrMask: " + 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\ApiProductsApi();
$catalogId = catalogId_example; // String | The uid of the catalog
$pageableDto = ; // Pageable | 
$versionId = versionId_example; // String | The uid of the catalog version
$currentPage = currentPage_example; // String | The requested page number
$langIsoCode = langIsoCode_example; // String | The language iso code by which products will be filtered
$mask = mask_example; // String | The string value on which products will be filtered if no text value is provided
$pageSize = pageSize_example; // String | The maximum number of elements in the result list.
$sort = sort_example; // String | The string field the results will be sorted with
$text = text_example; // String | The string value on which products will be filtered

try {
    $result = $api_instance->getProductsByTextOrMask($catalogId, $pageableDto, $versionId, $currentPage, $langIsoCode, $mask, $pageSize, $sort, $text);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->getProductsByTextOrMask: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProductsApi;

# 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::ProductsApi->new();
my $catalogId = catalogId_example; # String | The uid of the catalog
my $pageableDto = ; # Pageable | 
my $versionId = versionId_example; # String | The uid of the catalog version
my $currentPage = currentPage_example; # String | The requested page number
my $langIsoCode = langIsoCode_example; # String | The language iso code by which products will be filtered
my $mask = mask_example; # String | The string value on which products will be filtered if no text value is provided
my $pageSize = pageSize_example; # String | The maximum number of elements in the result list.
my $sort = sort_example; # String | The string field the results will be sorted with
my $text = text_example; # String | The string value on which products will be filtered

eval { 
    my $result = $api_instance->getProductsByTextOrMask(catalogId => $catalogId, pageableDto => $pageableDto, versionId => $versionId, currentPage => $currentPage, langIsoCode => $langIsoCode, mask => $mask, pageSize => $pageSize, sort => $sort, text => $text);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductsApi->getProductsByTextOrMask: $@\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.ProductsApi()
catalogId = catalogId_example # String | The uid of the catalog
pageableDto =  # Pageable | 
versionId = versionId_example # String | The uid of the catalog version
currentPage = currentPage_example # String | The requested page number (optional) (default to 0)
langIsoCode = langIsoCode_example # String | The language iso code by which products will be filtered (optional)
mask = mask_example # String | The string value on which products will be filtered if no text value is provided (optional)
pageSize = pageSize_example # String | The maximum number of elements in the result list. (optional) (default to 10)
sort = sort_example # String | The string field the results will be sorted with (optional)
text = text_example # String | The string value on which products will be filtered (optional)

try: 
    # Find products by text or mask
    api_response = api_instance.get_products_by_text_or_mask(catalogId, pageableDto, versionId, currentPage=currentPage, langIsoCode=langIsoCode, mask=mask, pageSize=pageSize, sort=sort, text=text)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductsApi->getProductsByTextOrMask: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The uid of the catalog
Required
versionId*
String
The uid of the catalog version
Required
Query parameters
Name Description
currentPage
String
The requested page number
langIsoCode
String
The language iso code by which products will be filtered
mask
String
The string value on which products will be filtered if no text value is provided
pageSize
String
The maximum number of elements in the result list.
pageableDto*
Pageable
Required
sort
String
The string field the results will be sorted with
text
String
The string value on which products will be filtered

Responses

Status: 200 - DTO which serves as a wrapper object that contains a list of ProductData, never null

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


Synchronizations

getSynchronizationStatus

Get synchronization status

Will build the synchronization status of a page including detailed status of its content slots and their cms components.


/v1/sites/{baseSiteId}/catalogs/{catalogId}/versions/{versionId}/synchronizations/versions/{targetCatalogVersion}/pages/{pageId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmssmarteditwebservices/v1/sites/{baseSiteId}/catalogs/{catalogId}/versions/{versionId}/synchronizations/versions/{targetCatalogVersion}/pages/{pageId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SynchronizationsApi;

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

public class SynchronizationsApiExample {

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

        SynchronizationsApi apiInstance = new SynchronizationsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String catalogId = catalogId_example; // String | The catalog uid
        String pageId = pageId_example; // String | The uid of the page from which to retrieve the synchronization status
        String targetCatalogVersion = targetCatalogVersion_example; // String | The target catalog version from a synchronization perspective
        String versionId = versionId_example; // String | The source catalog version from a synchronization perspective
        try {
            syncItemStatus result = apiInstance.getSynchronizationStatus(baseSiteId, catalogId, pageId, targetCatalogVersion, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SynchronizationsApi#getSynchronizationStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SynchronizationsApi;

public class SynchronizationsApiExample {

    public static void main(String[] args) {
        SynchronizationsApi apiInstance = new SynchronizationsApi();
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String catalogId = catalogId_example; // String | The catalog uid
        String pageId = pageId_example; // String | The uid of the page from which to retrieve the synchronization status
        String targetCatalogVersion = targetCatalogVersion_example; // String | The target catalog version from a synchronization perspective
        String versionId = versionId_example; // String | The source catalog version from a synchronization perspective
        try {
            syncItemStatus result = apiInstance.getSynchronizationStatus(baseSiteId, catalogId, pageId, targetCatalogVersion, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SynchronizationsApi#getSynchronizationStatus");
            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 *baseSiteId = baseSiteId_example; // Base site identifier
String *catalogId = catalogId_example; // The catalog uid
String *pageId = pageId_example; // The uid of the page from which to retrieve the synchronization status
String *targetCatalogVersion = targetCatalogVersion_example; // The target catalog version from a synchronization perspective
String *versionId = versionId_example; // The source catalog version from a synchronization perspective

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

// Get synchronization status
[apiInstance getSynchronizationStatusWith:baseSiteId
    catalogId:catalogId
    pageId:pageId
    targetCatalogVersion:targetCatalogVersion
    versionId:versionId
              completionHandler: ^(syncItemStatus output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsSmartEditWebservices = require('cms_smart_edit_webservices');
var defaultClient = CmsSmartEditWebservices.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 CmsSmartEditWebservices.SynchronizationsApi()
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var catalogId = catalogId_example; // {{String}} The catalog uid
var pageId = pageId_example; // {{String}} The uid of the page from which to retrieve the synchronization status
var targetCatalogVersion = targetCatalogVersion_example; // {{String}} The target catalog version from a synchronization perspective
var versionId = versionId_example; // {{String}} The source catalog version from a synchronization perspective

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

namespace Example
{
    public class getSynchronizationStatusExample
    {
        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 SynchronizationsApi();
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var catalogId = catalogId_example;  // String | The catalog uid
            var pageId = pageId_example;  // String | The uid of the page from which to retrieve the synchronization status
            var targetCatalogVersion = targetCatalogVersion_example;  // String | The target catalog version from a synchronization perspective
            var versionId = versionId_example;  // String | The source catalog version from a synchronization perspective

            try
            {
                // Get synchronization status
                syncItemStatus result = apiInstance.getSynchronizationStatus(baseSiteId, catalogId, pageId, targetCatalogVersion, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SynchronizationsApi.getSynchronizationStatus: " + 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\ApiSynchronizationsApi();
$baseSiteId = baseSiteId_example; // String | Base site identifier
$catalogId = catalogId_example; // String | The catalog uid
$pageId = pageId_example; // String | The uid of the page from which to retrieve the synchronization status
$targetCatalogVersion = targetCatalogVersion_example; // String | The target catalog version from a synchronization perspective
$versionId = versionId_example; // String | The source catalog version from a synchronization perspective

try {
    $result = $api_instance->getSynchronizationStatus($baseSiteId, $catalogId, $pageId, $targetCatalogVersion, $versionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SynchronizationsApi->getSynchronizationStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SynchronizationsApi;

# 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::SynchronizationsApi->new();
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $catalogId = catalogId_example; # String | The catalog uid
my $pageId = pageId_example; # String | The uid of the page from which to retrieve the synchronization status
my $targetCatalogVersion = targetCatalogVersion_example; # String | The target catalog version from a synchronization perspective
my $versionId = versionId_example; # String | The source catalog version from a synchronization perspective

eval { 
    my $result = $api_instance->getSynchronizationStatus(baseSiteId => $baseSiteId, catalogId => $catalogId, pageId => $pageId, targetCatalogVersion => $targetCatalogVersion, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SynchronizationsApi->getSynchronizationStatus: $@\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.SynchronizationsApi()
baseSiteId = baseSiteId_example # String | Base site identifier
catalogId = catalogId_example # String | The catalog uid
pageId = pageId_example # String | The uid of the page from which to retrieve the synchronization status
targetCatalogVersion = targetCatalogVersion_example # String | The target catalog version from a synchronization perspective
versionId = versionId_example # String | The source catalog version from a synchronization perspective

try: 
    # Get synchronization status
    api_response = api_instance.get_synchronization_status(baseSiteId, catalogId, pageId, targetCatalogVersion, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SynchronizationsApi->getSynchronizationStatus: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
catalogId*
String
The catalog uid
Required
pageId*
String
The uid of the page from which to retrieve the synchronization status
Required
targetCatalogVersion*
String
The target catalog version from a synchronization perspective
Required
versionId*
String
The source catalog version from a synchronization perspective
Required

Responses

Status: 200 - DTO containing the complex synchronization status of the AbstractPageModel page

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


performSynchronization

Perform synchronization

Will perform synchronization status on a list of item identifier by their ItemSynchronizationWsDTO.


/v1/sites/{baseSiteId}/catalogs/{catalogId}/versions/{versionId}/synchronizations/versions/{targetCatalogVersion}

Usage and SDK Samples

curl -X POST\
\
\
-H "Content-Type: application/json"\
"http://localhost:9001/cmssmarteditwebservices/v1/sites/{baseSiteId}/catalogs/{catalogId}/versions/{versionId}/synchronizations/versions/{targetCatalogVersion}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SynchronizationsApi;

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

public class SynchronizationsApiExample {

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

        SynchronizationsApi apiInstance = new SynchronizationsApi();
        Synchronization body = ; // Synchronization | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String catalogId = catalogId_example; // String | The catalog uid
        String targetCatalogVersion = targetCatalogVersion_example; // String | The target catalog version from a synchronization perspective
        String versionId = versionId_example; // String | The source catalog version from a synchronization perspective
        try {
            apiInstance.performSynchronization(body, baseSiteId, catalogId, targetCatalogVersion, versionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SynchronizationsApi#performSynchronization");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SynchronizationsApi;

public class SynchronizationsApiExample {

    public static void main(String[] args) {
        SynchronizationsApi apiInstance = new SynchronizationsApi();
        Synchronization body = ; // Synchronization | 
        String baseSiteId = baseSiteId_example; // String | Base site identifier
        String catalogId = catalogId_example; // String | The catalog uid
        String targetCatalogVersion = targetCatalogVersion_example; // String | The target catalog version from a synchronization perspective
        String versionId = versionId_example; // String | The source catalog version from a synchronization perspective
        try {
            apiInstance.performSynchronization(body, baseSiteId, catalogId, targetCatalogVersion, versionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SynchronizationsApi#performSynchronization");
            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"];
Synchronization *body = ; // 
String *baseSiteId = baseSiteId_example; // Base site identifier
String *catalogId = catalogId_example; // The catalog uid
String *targetCatalogVersion = targetCatalogVersion_example; // The target catalog version from a synchronization perspective
String *versionId = versionId_example; // The source catalog version from a synchronization perspective

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

// Perform synchronization
[apiInstance performSynchronizationWith:body
    baseSiteId:baseSiteId
    catalogId:catalogId
    targetCatalogVersion:targetCatalogVersion
    versionId:versionId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsSmartEditWebservices = require('cms_smart_edit_webservices');
var defaultClient = CmsSmartEditWebservices.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 CmsSmartEditWebservices.SynchronizationsApi()
var body = ; // {{Synchronization}} 
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var catalogId = catalogId_example; // {{String}} The catalog uid
var targetCatalogVersion = targetCatalogVersion_example; // {{String}} The target catalog version from a synchronization perspective
var versionId = versionId_example; // {{String}} The source catalog version from a synchronization perspective

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

namespace Example
{
    public class performSynchronizationExample
    {
        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 SynchronizationsApi();
            var body = new Synchronization(); // Synchronization | 
            var baseSiteId = baseSiteId_example;  // String | Base site identifier
            var catalogId = catalogId_example;  // String | The catalog uid
            var targetCatalogVersion = targetCatalogVersion_example;  // String | The target catalog version from a synchronization perspective
            var versionId = versionId_example;  // String | The source catalog version from a synchronization perspective

            try
            {
                // Perform synchronization
                apiInstance.performSynchronization(body, baseSiteId, catalogId, targetCatalogVersion, versionId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SynchronizationsApi.performSynchronization: " + 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\ApiSynchronizationsApi();
$body = ; // Synchronization | 
$baseSiteId = baseSiteId_example; // String | Base site identifier
$catalogId = catalogId_example; // String | The catalog uid
$targetCatalogVersion = targetCatalogVersion_example; // String | The target catalog version from a synchronization perspective
$versionId = versionId_example; // String | The source catalog version from a synchronization perspective

try {
    $api_instance->performSynchronization($body, $baseSiteId, $catalogId, $targetCatalogVersion, $versionId);
} catch (Exception $e) {
    echo 'Exception when calling SynchronizationsApi->performSynchronization: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SynchronizationsApi;

# 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::SynchronizationsApi->new();
my $body = WWW::SwaggerClient::Object::Synchronization->new(); # Synchronization | 
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $catalogId = catalogId_example; # String | The catalog uid
my $targetCatalogVersion = targetCatalogVersion_example; # String | The target catalog version from a synchronization perspective
my $versionId = versionId_example; # String | The source catalog version from a synchronization perspective

eval { 
    $api_instance->performSynchronization(body => $body, baseSiteId => $baseSiteId, catalogId => $catalogId, targetCatalogVersion => $targetCatalogVersion, versionId => $versionId);
};
if ($@) {
    warn "Exception when calling SynchronizationsApi->performSynchronization: $@\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.SynchronizationsApi()
body =  # Synchronization | 
baseSiteId = baseSiteId_example # String | Base site identifier
catalogId = catalogId_example # String | The catalog uid
targetCatalogVersion = targetCatalogVersion_example # String | The target catalog version from a synchronization perspective
versionId = versionId_example # String | The source catalog version from a synchronization perspective

try: 
    # Perform synchronization
    api_instance.perform_synchronization(body, baseSiteId, catalogId, targetCatalogVersion, versionId)
except ApiException as e:
    print("Exception when calling SynchronizationsApi->performSynchronization: %s\n" % e)

Parameters

Path parameters
Name Description
baseSiteId*
String
Base site identifier
Required
catalogId*
String
The catalog uid
Required
targetCatalogVersion*
String
The target catalog version from a synchronization perspective
Required
versionId*
String
The source catalog version from a synchronization perspective
Required
Body parameters
Name Description
body *

Responses

Status: 204 - No Content

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


Workflows

getObjectListOfEditableItems

Retrieves the list of objects that tells whether a particular item is editable in any workflow or not

Retrieves the list of objects that tells whether a particular item is editable in any workflow or not


/v1/catalogs/{catalogId}/versions/{versionId}/workfloweditableitems

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmssmarteditwebservices/v1/catalogs/{catalogId}/versions/{versionId}/workfloweditableitems?itemUids="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WorkflowsApi;

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

public class WorkflowsApiExample {

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

        WorkflowsApi apiInstance = new WorkflowsApi();
        String catalogId = catalogId_example; // String | The uid of the catalog
        array[String] itemUids = ; // array[String] | List of item uids
        String versionId = versionId_example; // String | The uid of the catalog version
        try {
            CMSWorkflowEditableItemList result = apiInstance.getObjectListOfEditableItems(catalogId, itemUids, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkflowsApi#getObjectListOfEditableItems");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WorkflowsApi;

public class WorkflowsApiExample {

    public static void main(String[] args) {
        WorkflowsApi apiInstance = new WorkflowsApi();
        String catalogId = catalogId_example; // String | The uid of the catalog
        array[String] itemUids = ; // array[String] | List of item uids
        String versionId = versionId_example; // String | The uid of the catalog version
        try {
            CMSWorkflowEditableItemList result = apiInstance.getObjectListOfEditableItems(catalogId, itemUids, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkflowsApi#getObjectListOfEditableItems");
            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 *catalogId = catalogId_example; // The uid of the catalog
array[String] *itemUids = ; // List of item uids
String *versionId = versionId_example; // The uid of the catalog version

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

// Retrieves the list of objects that tells whether a particular item is editable in any workflow or not
[apiInstance getObjectListOfEditableItemsWith:catalogId
    itemUids:itemUids
    versionId:versionId
              completionHandler: ^(CMSWorkflowEditableItemList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsSmartEditWebservices = require('cms_smart_edit_webservices');
var defaultClient = CmsSmartEditWebservices.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 CmsSmartEditWebservices.WorkflowsApi()
var catalogId = catalogId_example; // {{String}} The uid of the catalog
var itemUids = ; // {{array[String]}} List of item uids
var versionId = versionId_example; // {{String}} The uid of the catalog version

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

namespace Example
{
    public class getObjectListOfEditableItemsExample
    {
        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 WorkflowsApi();
            var catalogId = catalogId_example;  // String | The uid of the catalog
            var itemUids = new array[String](); // array[String] | List of item uids
            var versionId = versionId_example;  // String | The uid of the catalog version

            try
            {
                // Retrieves the list of objects that tells whether a particular item is editable in any workflow or not
                CMSWorkflowEditableItemList result = apiInstance.getObjectListOfEditableItems(catalogId, itemUids, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WorkflowsApi.getObjectListOfEditableItems: " + 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\ApiWorkflowsApi();
$catalogId = catalogId_example; // String | The uid of the catalog
$itemUids = ; // array[String] | List of item uids
$versionId = versionId_example; // String | The uid of the catalog version

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

# 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::WorkflowsApi->new();
my $catalogId = catalogId_example; # String | The uid of the catalog
my $itemUids = []; # array[String] | List of item uids
my $versionId = versionId_example; # String | The uid of the catalog version

eval { 
    my $result = $api_instance->getObjectListOfEditableItems(catalogId => $catalogId, itemUids => $itemUids, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WorkflowsApi->getObjectListOfEditableItems: $@\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.WorkflowsApi()
catalogId = catalogId_example # String | The uid of the catalog
itemUids =  # array[String] | List of item uids
versionId = versionId_example # String | The uid of the catalog version

try: 
    # Retrieves the list of objects that tells whether a particular item is editable in any workflow or not
    api_response = api_instance.get_object_list_of_editable_items(catalogId, itemUids, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WorkflowsApi->getObjectListOfEditableItems: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The uid of the catalog
Required
versionId*
String
The uid of the catalog version
Required
Query parameters
Name Description
itemUids*
array[String]
List of item uids
Required

Responses

Status: 200 - The dto containing the list of objects that tells whether a particular item is editable in any workflow or not.

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - When no cms item is found matching the given uid (UnknownIdentifierException).