Cms Webservices

CatalogVersionMedia

doUploadMultipartMedia

Uploads media.

Provides a new multipart media item for a given catalogId.


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

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/cmswebservices/v1/catalogs/{catalogId}/versions/{versionId}/media?altText=&code=&description=&folder=&mime="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CatalogVersionMediaApi;

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

public class CatalogVersionMediaApiExample {

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

        CatalogVersionMediaApi apiInstance = new CatalogVersionMediaApi();
        String altText = altText_example; // String | The alternative text to use for the newly created media.
        String code = code_example; // String | The code to use for the newly created media.
        String description = description_example; // String | The description to use for the newly created media.
        String folder = folder_example; // String | The folder that media will be update to
        String catalogId = catalogId_example; // String | The unique identifier of the catalog for which to link the new media.
        String versionId = versionId_example; // String | The specific catalog version to which the new media will be associated to.
        VersionId_media_body body = ; // VersionId_media_body | 
        String mime = mime_example; // String | Internet Media Type for the media file.
        try {
            MediaData result = apiInstance.doUploadMultipartMedia(altText, code, description, folder, catalogId, versionId, body, mime);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CatalogVersionMediaApi#doUploadMultipartMedia");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CatalogVersionMediaApi;

public class CatalogVersionMediaApiExample {

    public static void main(String[] args) {
        CatalogVersionMediaApi apiInstance = new CatalogVersionMediaApi();
        String altText = altText_example; // String | The alternative text to use for the newly created media.
        String code = code_example; // String | The code to use for the newly created media.
        String description = description_example; // String | The description to use for the newly created media.
        String folder = folder_example; // String | The folder that media will be update to
        String catalogId = catalogId_example; // String | The unique identifier of the catalog for which to link the new media.
        String versionId = versionId_example; // String | The specific catalog version to which the new media will be associated to.
        VersionId_media_body body = ; // VersionId_media_body | 
        String mime = mime_example; // String | Internet Media Type for the media file.
        try {
            MediaData result = apiInstance.doUploadMultipartMedia(altText, code, description, folder, catalogId, versionId, body, mime);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CatalogVersionMediaApi#doUploadMultipartMedia");
            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 *altText = altText_example; // The alternative text to use for the newly created media.
String *code = code_example; // The code to use for the newly created media.
String *description = description_example; // The description to use for the newly created media.
String *folder = folder_example; // The folder that media will be update to
String *catalogId = catalogId_example; // The unique identifier of the catalog for which to link the new media.
String *versionId = versionId_example; // The specific catalog version to which the new media will be associated to.
VersionId_media_body *body = ; //  (optional)
String *mime = mime_example; // Internet Media Type for the media file. (optional)

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

// Uploads media.
[apiInstance doUploadMultipartMediaWith:altText
    code:code
    description:description
    folder:folder
    catalogId:catalogId
    versionId:versionId
    body:body
    mime:mime
              completionHandler: ^(MediaData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.CatalogVersionMediaApi()
var altText = altText_example; // {{String}} The alternative text to use for the newly created media.
var code = code_example; // {{String}} The code to use for the newly created media.
var description = description_example; // {{String}} The description to use for the newly created media.
var folder = folder_example; // {{String}} The folder that media will be update to
var catalogId = catalogId_example; // {{String}} The unique identifier of the catalog for which to link the new media.
var versionId = versionId_example; // {{String}} The specific catalog version to which the new media will be associated to.
var opts = { 
  'body':  // {{VersionId_media_body}} 
  'mime': mime_example // {{String}} Internet Media Type for the media file.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.doUploadMultipartMedia(altTextcodedescriptionfoldercatalogIdversionId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class doUploadMultipartMediaExample
    {
        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 CatalogVersionMediaApi();
            var altText = altText_example;  // String | The alternative text to use for the newly created media.
            var code = code_example;  // String | The code to use for the newly created media.
            var description = description_example;  // String | The description to use for the newly created media.
            var folder = folder_example;  // String | The folder that media will be update to
            var catalogId = catalogId_example;  // String | The unique identifier of the catalog for which to link the new media.
            var versionId = versionId_example;  // String | The specific catalog version to which the new media will be associated to.
            var body = new VersionId_media_body(); // VersionId_media_body |  (optional) 
            var mime = mime_example;  // String | Internet Media Type for the media file. (optional) 

            try
            {
                // Uploads media.
                MediaData result = apiInstance.doUploadMultipartMedia(altText, code, description, folder, catalogId, versionId, body, mime);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CatalogVersionMediaApi.doUploadMultipartMedia: " + 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\ApiCatalogVersionMediaApi();
$altText = altText_example; // String | The alternative text to use for the newly created media.
$code = code_example; // String | The code to use for the newly created media.
$description = description_example; // String | The description to use for the newly created media.
$folder = folder_example; // String | The folder that media will be update to
$catalogId = catalogId_example; // String | The unique identifier of the catalog for which to link the new media.
$versionId = versionId_example; // String | The specific catalog version to which the new media will be associated to.
$body = ; // VersionId_media_body | 
$mime = mime_example; // String | Internet Media Type for the media file.

try {
    $result = $api_instance->doUploadMultipartMedia($altText, $code, $description, $folder, $catalogId, $versionId, $body, $mime);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CatalogVersionMediaApi->doUploadMultipartMedia: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CatalogVersionMediaApi;

# 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::CatalogVersionMediaApi->new();
my $altText = altText_example; # String | The alternative text to use for the newly created media.
my $code = code_example; # String | The code to use for the newly created media.
my $description = description_example; # String | The description to use for the newly created media.
my $folder = folder_example; # String | The folder that media will be update to
my $catalogId = catalogId_example; # String | The unique identifier of the catalog for which to link the new media.
my $versionId = versionId_example; # String | The specific catalog version to which the new media will be associated to.
my $body = WWW::SwaggerClient::Object::VersionId_media_body->new(); # VersionId_media_body | 
my $mime = mime_example; # String | Internet Media Type for the media file.

eval { 
    my $result = $api_instance->doUploadMultipartMedia(altText => $altText, code => $code, description => $description, folder => $folder, catalogId => $catalogId, versionId => $versionId, body => $body, mime => $mime);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CatalogVersionMediaApi->doUploadMultipartMedia: $@\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.CatalogVersionMediaApi()
altText = altText_example # String | The alternative text to use for the newly created media.
code = code_example # String | The code to use for the newly created media.
description = description_example # String | The description to use for the newly created media.
folder = folder_example # String | The folder that media will be update to
catalogId = catalogId_example # String | The unique identifier of the catalog for which to link the new media.
versionId = versionId_example # String | The specific catalog version to which the new media will be associated to.
body =  # VersionId_media_body |  (optional)
mime = mime_example # String | Internet Media Type for the media file. (optional)

try: 
    # Uploads media.
    api_response = api_instance.do_upload_multipart_media(altText, code, description, folder, catalogId, versionId, body=body, mime=mime)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CatalogVersionMediaApi->doUploadMultipartMedia: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The unique identifier of the catalog for which to link the new media.
Required
versionId*
String
The specific catalog version to which the new media will be associated to.
Required
Body parameters
Name Description
body
Query parameters
Name Description
altText*
String
The alternative text to use for the newly created media.
Required
code*
String
The code to use for the newly created media.
Required
description*
String
The description to use for the newly created media.
Required
folder*
String
The folder that media will be update to
Required
mime
String
Internet Media Type for the media file.

Responses

Status: 200 - The newly created Media item

Status: 400 - When an error occurs parsing the MultipartFile (IOException) or when the media query parameters provided contain validation errors (WebserviceValidationException)

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


CatalogVersionSynchronization

createNewSynchronizationByCatalog

Creates a catalog synchronization.

Generates a brand new synchronization status. The status is generated based on a given catalog, source version and target version ids.


/v1/catalogs/{catalogId}/versions/{sourceVersionId}/synchronizations/versions/{targetVersionId}

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/cmswebservices/v1/catalogs/{catalogId}/versions/{sourceVersionId}/synchronizations/versions/{targetVersionId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CatalogVersionSynchronizationApi;

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

public class CatalogVersionSynchronizationApiExample {

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

        CatalogVersionSynchronizationApi apiInstance = new CatalogVersionSynchronizationApi();
        String catalogId = catalogId_example; // String | The catalog id
        String sourceVersionId = sourceVersionId_example; // String | Catalog version used as a starting point in this synchronization
        String targetVersionId = targetVersionId_example; // String | Catalog version destination to be synchronized
        SyncJobRequestData body = ; // SyncJobRequestData | 
        try {
            SyncJobData result = apiInstance.createNewSynchronizationByCatalog(catalogId, sourceVersionId, targetVersionId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CatalogVersionSynchronizationApi#createNewSynchronizationByCatalog");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CatalogVersionSynchronizationApi;

public class CatalogVersionSynchronizationApiExample {

    public static void main(String[] args) {
        CatalogVersionSynchronizationApi apiInstance = new CatalogVersionSynchronizationApi();
        String catalogId = catalogId_example; // String | The catalog id
        String sourceVersionId = sourceVersionId_example; // String | Catalog version used as a starting point in this synchronization
        String targetVersionId = targetVersionId_example; // String | Catalog version destination to be synchronized
        SyncJobRequestData body = ; // SyncJobRequestData | 
        try {
            SyncJobData result = apiInstance.createNewSynchronizationByCatalog(catalogId, sourceVersionId, targetVersionId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CatalogVersionSynchronizationApi#createNewSynchronizationByCatalog");
            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
String *sourceVersionId = sourceVersionId_example; // Catalog version used as a starting point in this synchronization
String *targetVersionId = targetVersionId_example; // Catalog version destination to be synchronized
SyncJobRequestData *body = ; //  (optional)

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

// Creates a catalog synchronization.
[apiInstance createNewSynchronizationByCatalogWith:catalogId
    sourceVersionId:sourceVersionId
    targetVersionId:targetVersionId
    body:body
              completionHandler: ^(SyncJobData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.CatalogVersionSynchronizationApi()
var catalogId = catalogId_example; // {{String}} The catalog id
var sourceVersionId = sourceVersionId_example; // {{String}} Catalog version used as a starting point in this synchronization
var targetVersionId = targetVersionId_example; // {{String}} Catalog version destination to be synchronized
var opts = { 
  'body':  // {{SyncJobRequestData}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createNewSynchronizationByCatalog(catalogIdsourceVersionIdtargetVersionId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createNewSynchronizationByCatalogExample
    {
        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 CatalogVersionSynchronizationApi();
            var catalogId = catalogId_example;  // String | The catalog id
            var sourceVersionId = sourceVersionId_example;  // String | Catalog version used as a starting point in this synchronization
            var targetVersionId = targetVersionId_example;  // String | Catalog version destination to be synchronized
            var body = new SyncJobRequestData(); // SyncJobRequestData |  (optional) 

            try
            {
                // Creates a catalog synchronization.
                SyncJobData result = apiInstance.createNewSynchronizationByCatalog(catalogId, sourceVersionId, targetVersionId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CatalogVersionSynchronizationApi.createNewSynchronizationByCatalog: " + 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\ApiCatalogVersionSynchronizationApi();
$catalogId = catalogId_example; // String | The catalog id
$sourceVersionId = sourceVersionId_example; // String | Catalog version used as a starting point in this synchronization
$targetVersionId = targetVersionId_example; // String | Catalog version destination to be synchronized
$body = ; // SyncJobRequestData | 

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

# 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::CatalogVersionSynchronizationApi->new();
my $catalogId = catalogId_example; # String | The catalog id
my $sourceVersionId = sourceVersionId_example; # String | Catalog version used as a starting point in this synchronization
my $targetVersionId = targetVersionId_example; # String | Catalog version destination to be synchronized
my $body = WWW::SwaggerClient::Object::SyncJobRequestData->new(); # SyncJobRequestData | 

eval { 
    my $result = $api_instance->createNewSynchronizationByCatalog(catalogId => $catalogId, sourceVersionId => $sourceVersionId, targetVersionId => $targetVersionId, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CatalogVersionSynchronizationApi->createNewSynchronizationByCatalog: $@\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.CatalogVersionSynchronizationApi()
catalogId = catalogId_example # String | The catalog id
sourceVersionId = sourceVersionId_example # String | Catalog version used as a starting point in this synchronization
targetVersionId = targetVersionId_example # String | Catalog version destination to be synchronized
body =  # SyncJobRequestData |  (optional)

try: 
    # Creates a catalog synchronization.
    api_response = api_instance.create_new_synchronization_by_catalog(catalogId, sourceVersionId, targetVersionId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CatalogVersionSynchronizationApi->createNewSynchronizationByCatalog: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog id
Required
sourceVersionId*
String
Catalog version used as a starting point in this synchronization
Required
targetVersionId*
String
Catalog version destination to be synchronized
Required
Body parameters
Name Description
body

Responses

Status: 200 - The synchronization status

Status: 400 - When one of the catalogs does not exist (CMSItemNotFoundException).

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getLastSynchronizationByCatalog

Gets last synchronization by target catalog.

Retrieves the status of the last synchronization job. Information is retrieved based on the catalog version target.


/v1/catalogs/{catalogId}/synchronizations/targetversions/{targetVersionId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/catalogs/{catalogId}/synchronizations/targetversions/{targetVersionId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CatalogVersionSynchronizationApi;

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

public class CatalogVersionSynchronizationApiExample {

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

        CatalogVersionSynchronizationApi apiInstance = new CatalogVersionSynchronizationApi();
        String catalogId = catalogId_example; // String | The catalog id
        String targetVersionId = targetVersionId_example; // String | Catalog version destination to be synchronized
        try {
            SyncJobData result = apiInstance.getLastSynchronizationByCatalog(catalogId, targetVersionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CatalogVersionSynchronizationApi#getLastSynchronizationByCatalog");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CatalogVersionSynchronizationApi;

public class CatalogVersionSynchronizationApiExample {

    public static void main(String[] args) {
        CatalogVersionSynchronizationApi apiInstance = new CatalogVersionSynchronizationApi();
        String catalogId = catalogId_example; // String | The catalog id
        String targetVersionId = targetVersionId_example; // String | Catalog version destination to be synchronized
        try {
            SyncJobData result = apiInstance.getLastSynchronizationByCatalog(catalogId, targetVersionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CatalogVersionSynchronizationApi#getLastSynchronizationByCatalog");
            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
String *targetVersionId = targetVersionId_example; // Catalog version destination to be synchronized

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

// Gets last synchronization by target catalog.
[apiInstance getLastSynchronizationByCatalogWith:catalogId
    targetVersionId:targetVersionId
              completionHandler: ^(SyncJobData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.CatalogVersionSynchronizationApi()
var catalogId = catalogId_example; // {{String}} The catalog id
var targetVersionId = targetVersionId_example; // {{String}} Catalog version destination to be synchronized

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

namespace Example
{
    public class getLastSynchronizationByCatalogExample
    {
        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 CatalogVersionSynchronizationApi();
            var catalogId = catalogId_example;  // String | The catalog id
            var targetVersionId = targetVersionId_example;  // String | Catalog version destination to be synchronized

            try
            {
                // Gets last synchronization by target catalog.
                SyncJobData result = apiInstance.getLastSynchronizationByCatalog(catalogId, targetVersionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CatalogVersionSynchronizationApi.getLastSynchronizationByCatalog: " + 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\ApiCatalogVersionSynchronizationApi();
$catalogId = catalogId_example; // String | The catalog id
$targetVersionId = targetVersionId_example; // String | Catalog version destination to be synchronized

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

# 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::CatalogVersionSynchronizationApi->new();
my $catalogId = catalogId_example; # String | The catalog id
my $targetVersionId = targetVersionId_example; # String | Catalog version destination to be synchronized

eval { 
    my $result = $api_instance->getLastSynchronizationByCatalog(catalogId => $catalogId, targetVersionId => $targetVersionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CatalogVersionSynchronizationApi->getLastSynchronizationByCatalog: $@\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.CatalogVersionSynchronizationApi()
catalogId = catalogId_example # String | The catalog id
targetVersionId = targetVersionId_example # String | Catalog version destination to be synchronized

try: 
    # Gets last synchronization by target catalog.
    api_response = api_instance.get_last_synchronization_by_catalog(catalogId, targetVersionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CatalogVersionSynchronizationApi->getLastSynchronizationByCatalog: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog id
Required
targetVersionId*
String
Catalog version destination to be synchronized
Required

Responses

Status: 200 - The synchronization status

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getSynchronizationByCatalog

Gets synchronization status.

Retrieves the status of the last synchronization for a catalog. Information is retrieved based on a given catalog, source version and target version ids.


/v1/catalogs/{catalogId}/versions/{sourceVersionId}/synchronizations/versions/{targetVersionId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/catalogs/{catalogId}/versions/{sourceVersionId}/synchronizations/versions/{targetVersionId}?syncJobRequest="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CatalogVersionSynchronizationApi;

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

public class CatalogVersionSynchronizationApiExample {

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

        CatalogVersionSynchronizationApi apiInstance = new CatalogVersionSynchronizationApi();
        String catalogId = catalogId_example; // String | The catalog id
        String sourceVersionId = sourceVersionId_example; // String | Catalog version used as a starting point in this synchronization
        SyncJobRequestData syncJobRequest = ; // SyncJobRequestData | Contains the synchronization request data
        String targetVersionId = targetVersionId_example; // String | Catalog version destination to be synchronized
        try {
            SyncJobData result = apiInstance.getSynchronizationByCatalog(catalogId, sourceVersionId, syncJobRequest, targetVersionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CatalogVersionSynchronizationApi#getSynchronizationByCatalog");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CatalogVersionSynchronizationApi;

public class CatalogVersionSynchronizationApiExample {

    public static void main(String[] args) {
        CatalogVersionSynchronizationApi apiInstance = new CatalogVersionSynchronizationApi();
        String catalogId = catalogId_example; // String | The catalog id
        String sourceVersionId = sourceVersionId_example; // String | Catalog version used as a starting point in this synchronization
        SyncJobRequestData syncJobRequest = ; // SyncJobRequestData | Contains the synchronization request data
        String targetVersionId = targetVersionId_example; // String | Catalog version destination to be synchronized
        try {
            SyncJobData result = apiInstance.getSynchronizationByCatalog(catalogId, sourceVersionId, syncJobRequest, targetVersionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CatalogVersionSynchronizationApi#getSynchronizationByCatalog");
            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
String *sourceVersionId = sourceVersionId_example; // Catalog version used as a starting point in this synchronization
SyncJobRequestData *syncJobRequest = ; // Contains the synchronization request data
String *targetVersionId = targetVersionId_example; // Catalog version destination to be synchronized

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

// Gets synchronization status.
[apiInstance getSynchronizationByCatalogWith:catalogId
    sourceVersionId:sourceVersionId
    syncJobRequest:syncJobRequest
    targetVersionId:targetVersionId
              completionHandler: ^(SyncJobData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.CatalogVersionSynchronizationApi()
var catalogId = catalogId_example; // {{String}} The catalog id
var sourceVersionId = sourceVersionId_example; // {{String}} Catalog version used as a starting point in this synchronization
var syncJobRequest = ; // {{SyncJobRequestData}} Contains the synchronization request data
var targetVersionId = targetVersionId_example; // {{String}} Catalog version destination to be synchronized

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

namespace Example
{
    public class getSynchronizationByCatalogExample
    {
        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 CatalogVersionSynchronizationApi();
            var catalogId = catalogId_example;  // String | The catalog id
            var sourceVersionId = sourceVersionId_example;  // String | Catalog version used as a starting point in this synchronization
            var syncJobRequest = new SyncJobRequestData(); // SyncJobRequestData | Contains the synchronization request data
            var targetVersionId = targetVersionId_example;  // String | Catalog version destination to be synchronized

            try
            {
                // Gets synchronization status.
                SyncJobData result = apiInstance.getSynchronizationByCatalog(catalogId, sourceVersionId, syncJobRequest, targetVersionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CatalogVersionSynchronizationApi.getSynchronizationByCatalog: " + 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\ApiCatalogVersionSynchronizationApi();
$catalogId = catalogId_example; // String | The catalog id
$sourceVersionId = sourceVersionId_example; // String | Catalog version used as a starting point in this synchronization
$syncJobRequest = ; // SyncJobRequestData | Contains the synchronization request data
$targetVersionId = targetVersionId_example; // String | Catalog version destination to be synchronized

try {
    $result = $api_instance->getSynchronizationByCatalog($catalogId, $sourceVersionId, $syncJobRequest, $targetVersionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CatalogVersionSynchronizationApi->getSynchronizationByCatalog: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CatalogVersionSynchronizationApi;

# 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::CatalogVersionSynchronizationApi->new();
my $catalogId = catalogId_example; # String | The catalog id
my $sourceVersionId = sourceVersionId_example; # String | Catalog version used as a starting point in this synchronization
my $syncJobRequest = ; # SyncJobRequestData | Contains the synchronization request data
my $targetVersionId = targetVersionId_example; # String | Catalog version destination to be synchronized

eval { 
    my $result = $api_instance->getSynchronizationByCatalog(catalogId => $catalogId, sourceVersionId => $sourceVersionId, syncJobRequest => $syncJobRequest, targetVersionId => $targetVersionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CatalogVersionSynchronizationApi->getSynchronizationByCatalog: $@\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.CatalogVersionSynchronizationApi()
catalogId = catalogId_example # String | The catalog id
sourceVersionId = sourceVersionId_example # String | Catalog version used as a starting point in this synchronization
syncJobRequest =  # SyncJobRequestData | Contains the synchronization request data
targetVersionId = targetVersionId_example # String | Catalog version destination to be synchronized

try: 
    # Gets synchronization status.
    api_response = api_instance.get_synchronization_by_catalog(catalogId, sourceVersionId, syncJobRequest, targetVersionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CatalogVersionSynchronizationApi->getSynchronizationByCatalog: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog id
Required
sourceVersionId*
String
Catalog version used as a starting point in this synchronization
Required
targetVersionId*
String
Catalog version destination to be synchronized
Required
Query parameters
Name Description
syncJobRequest*
SyncJobRequestData
Contains the synchronization request data
Required

Responses

Status: 200 - The synchronization status

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


replaceSynchronizationByCatalog

Creates a catalog synchronization.

Generates a brand new synchronization status. The status is generated based on a given catalog, source version and target version ids.


/v1/catalogs/{catalogId}/versions/{sourceVersionId}/synchronizations/versions/{targetVersionId}

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/cmswebservices/v1/catalogs/{catalogId}/versions/{sourceVersionId}/synchronizations/versions/{targetVersionId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CatalogVersionSynchronizationApi;

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

public class CatalogVersionSynchronizationApiExample {

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

        CatalogVersionSynchronizationApi apiInstance = new CatalogVersionSynchronizationApi();
        String catalogId = catalogId_example; // String | The catalog id
        String sourceVersionId = sourceVersionId_example; // String | Catalog version used as a starting point in this synchronization
        String targetVersionId = targetVersionId_example; // String | Catalog version destination to be synchronized
        SyncJobRequestData body = ; // SyncJobRequestData | 
        try {
            SyncJobData result = apiInstance.replaceSynchronizationByCatalog(catalogId, sourceVersionId, targetVersionId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CatalogVersionSynchronizationApi#replaceSynchronizationByCatalog");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CatalogVersionSynchronizationApi;

public class CatalogVersionSynchronizationApiExample {

    public static void main(String[] args) {
        CatalogVersionSynchronizationApi apiInstance = new CatalogVersionSynchronizationApi();
        String catalogId = catalogId_example; // String | The catalog id
        String sourceVersionId = sourceVersionId_example; // String | Catalog version used as a starting point in this synchronization
        String targetVersionId = targetVersionId_example; // String | Catalog version destination to be synchronized
        SyncJobRequestData body = ; // SyncJobRequestData | 
        try {
            SyncJobData result = apiInstance.replaceSynchronizationByCatalog(catalogId, sourceVersionId, targetVersionId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CatalogVersionSynchronizationApi#replaceSynchronizationByCatalog");
            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
String *sourceVersionId = sourceVersionId_example; // Catalog version used as a starting point in this synchronization
String *targetVersionId = targetVersionId_example; // Catalog version destination to be synchronized
SyncJobRequestData *body = ; //  (optional)

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

// Creates a catalog synchronization.
[apiInstance replaceSynchronizationByCatalogWith:catalogId
    sourceVersionId:sourceVersionId
    targetVersionId:targetVersionId
    body:body
              completionHandler: ^(SyncJobData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.CatalogVersionSynchronizationApi()
var catalogId = catalogId_example; // {{String}} The catalog id
var sourceVersionId = sourceVersionId_example; // {{String}} Catalog version used as a starting point in this synchronization
var targetVersionId = targetVersionId_example; // {{String}} Catalog version destination to be synchronized
var opts = { 
  'body':  // {{SyncJobRequestData}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.replaceSynchronizationByCatalog(catalogIdsourceVersionIdtargetVersionId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class replaceSynchronizationByCatalogExample
    {
        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 CatalogVersionSynchronizationApi();
            var catalogId = catalogId_example;  // String | The catalog id
            var sourceVersionId = sourceVersionId_example;  // String | Catalog version used as a starting point in this synchronization
            var targetVersionId = targetVersionId_example;  // String | Catalog version destination to be synchronized
            var body = new SyncJobRequestData(); // SyncJobRequestData |  (optional) 

            try
            {
                // Creates a catalog synchronization.
                SyncJobData result = apiInstance.replaceSynchronizationByCatalog(catalogId, sourceVersionId, targetVersionId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CatalogVersionSynchronizationApi.replaceSynchronizationByCatalog: " + 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\ApiCatalogVersionSynchronizationApi();
$catalogId = catalogId_example; // String | The catalog id
$sourceVersionId = sourceVersionId_example; // String | Catalog version used as a starting point in this synchronization
$targetVersionId = targetVersionId_example; // String | Catalog version destination to be synchronized
$body = ; // SyncJobRequestData | 

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

# 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::CatalogVersionSynchronizationApi->new();
my $catalogId = catalogId_example; # String | The catalog id
my $sourceVersionId = sourceVersionId_example; # String | Catalog version used as a starting point in this synchronization
my $targetVersionId = targetVersionId_example; # String | Catalog version destination to be synchronized
my $body = WWW::SwaggerClient::Object::SyncJobRequestData->new(); # SyncJobRequestData | 

eval { 
    my $result = $api_instance->replaceSynchronizationByCatalog(catalogId => $catalogId, sourceVersionId => $sourceVersionId, targetVersionId => $targetVersionId, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CatalogVersionSynchronizationApi->replaceSynchronizationByCatalog: $@\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.CatalogVersionSynchronizationApi()
catalogId = catalogId_example # String | The catalog id
sourceVersionId = sourceVersionId_example # String | Catalog version used as a starting point in this synchronization
targetVersionId = targetVersionId_example # String | Catalog version destination to be synchronized
body =  # SyncJobRequestData |  (optional)

try: 
    # Creates a catalog synchronization.
    api_response = api_instance.replace_synchronization_by_catalog(catalogId, sourceVersionId, targetVersionId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CatalogVersionSynchronizationApi->replaceSynchronizationByCatalog: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog id
Required
sourceVersionId*
String
Catalog version used as a starting point in this synchronization
Required
targetVersionId*
String
Catalog version destination to be synchronized
Required
Body parameters
Name Description
body

Responses

Status: 200 - The synchronization status

Status: 400 - When one of the catalogs does not exist (CMSItemNotFoundException).

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


CatalogVersions

getWritableContentCatalogVersion

Gets writable content catalog versions.

Retrieves a target content catalog versions by mode. For mode = "cloneableTo" returns the list of content catalog versions (which are used as targets for page clone operations) for a given catalog or all child catalogs.


/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/targets

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/targets?mode="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CatalogVersionsApi;

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

public class CatalogVersionsApiExample {

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

        CatalogVersionsApi apiInstance = new CatalogVersionsApi();
        String catalogId = catalogId_example; // String | The catalog identifier
        String mode = mode_example; // String | The mode to filter the result
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The version of the catalog
        try {
            CatalogVersionListData result = apiInstance.getWritableContentCatalogVersion(catalogId, mode, siteId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CatalogVersionsApi#getWritableContentCatalogVersion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CatalogVersionsApi;

public class CatalogVersionsApiExample {

    public static void main(String[] args) {
        CatalogVersionsApi apiInstance = new CatalogVersionsApi();
        String catalogId = catalogId_example; // String | The catalog identifier
        String mode = mode_example; // String | The mode to filter the result
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The version of the catalog
        try {
            CatalogVersionListData result = apiInstance.getWritableContentCatalogVersion(catalogId, mode, siteId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CatalogVersionsApi#getWritableContentCatalogVersion");
            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 identifier
String *mode = mode_example; // The mode to filter the result
String *siteId = siteId_example; // The site identifier
String *versionId = versionId_example; // The version of the catalog

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

// Gets writable content catalog versions.
[apiInstance getWritableContentCatalogVersionWith:catalogId
    mode:mode
    siteId:siteId
    versionId:versionId
              completionHandler: ^(CatalogVersionListData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.CatalogVersionsApi()
var catalogId = catalogId_example; // {{String}} The catalog identifier
var mode = mode_example; // {{String}} The mode to filter the result
var siteId = siteId_example; // {{String}} The site identifier
var versionId = versionId_example; // {{String}} The version of the catalog

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

namespace Example
{
    public class getWritableContentCatalogVersionExample
    {
        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 CatalogVersionsApi();
            var catalogId = catalogId_example;  // String | The catalog identifier
            var mode = mode_example;  // String | The mode to filter the result
            var siteId = siteId_example;  // String | The site identifier
            var versionId = versionId_example;  // String | The version of the catalog

            try
            {
                // Gets writable content catalog versions.
                CatalogVersionListData result = apiInstance.getWritableContentCatalogVersion(catalogId, mode, siteId, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CatalogVersionsApi.getWritableContentCatalogVersion: " + 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\ApiCatalogVersionsApi();
$catalogId = catalogId_example; // String | The catalog identifier
$mode = mode_example; // String | The mode to filter the result
$siteId = siteId_example; // String | The site identifier
$versionId = versionId_example; // String | The version of the catalog

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

# 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::CatalogVersionsApi->new();
my $catalogId = catalogId_example; # String | The catalog identifier
my $mode = mode_example; # String | The mode to filter the result
my $siteId = siteId_example; # String | The site identifier
my $versionId = versionId_example; # String | The version of the catalog

eval { 
    my $result = $api_instance->getWritableContentCatalogVersion(catalogId => $catalogId, mode => $mode, siteId => $siteId, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CatalogVersionsApi->getWritableContentCatalogVersion: $@\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.CatalogVersionsApi()
catalogId = catalogId_example # String | The catalog identifier
mode = mode_example # String | The mode to filter the result
siteId = siteId_example # String | The site identifier
versionId = versionId_example # String | The version of the catalog

try: 
    # Gets writable content catalog versions.
    api_response = api_instance.get_writable_content_catalog_version(catalogId, mode, siteId, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CatalogVersionsApi->getWritableContentCatalogVersion: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog identifier
Required
siteId*
String
The site identifier
Required
versionId*
String
The version of the catalog
Required
Query parameters
Name Description
mode*
String
The mode to filter the result
Required

Responses

Status: 200 - The list of content catalog versions.

Status: 400 - When the catalog and/or version specified is not valid (CMSItemNotFoundException).

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


Cmsitems

getCMSItemByPagedSearch

Finds CMS items.

Retrieves a list of available CMS items that match pages search.


/v1/sites/{siteId}/cmsitems

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/sites/{siteId}/cmsitems?catalogId=&catalogVersion=&cmsItemSearchInfo=¤tPage=&fields=&itemSearchParams=&mask=&pageSize=&pageableInfo=&sort=&typeCode=&typeCodes="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CmsitemsApi;

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

public class CmsitemsApiExample {

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

        CmsitemsApi apiInstance = new CmsitemsApi();
        String catalogId = catalogId_example; // String | The catalog id
        String catalogVersion = catalogVersion_example; // String | CatalogVersion on which to search
        CMSItemSearch cmsItemSearchInfo = ; // CMSItemSearch | CMS Item search DTO
        String currentPage = currentPage_example; // String | The current result page requested
        String pageSize = pageSize_example; // String | Page size for paging
        Pageable pageableInfo = ; // Pageable | Pageable DTO
        String siteId = siteId_example; // String | The site identifier
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response
        String itemSearchParams = itemSearchParams_example; // String | Search on additional fields using a comma separated list of field name and value pairs which are separated by a colon. Exact matches only. You can use {@code null} as value.
        String mask = mask_example; // String | Search mask applied to the UID and NAME fields, Uses partial matching
        String sort = sort_example; // String | The requested ordering for the search results.
        String typeCode = typeCode_example; // String | TypeCode filter. Exact matches only. Either typeCode or typeCodes can be set.
        String typeCodes = typeCodes_example; // String | Search using a comma separated list of type code. Either typeCode or typeCodes can be set.
        try {
            map['String', Object] result = apiInstance.getCMSItemByPagedSearch(catalogId, catalogVersion, cmsItemSearchInfo, currentPage, pageSize, pageableInfo, siteId, fields, itemSearchParams, mask, sort, typeCode, typeCodes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CmsitemsApi#getCMSItemByPagedSearch");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CmsitemsApi;

public class CmsitemsApiExample {

    public static void main(String[] args) {
        CmsitemsApi apiInstance = new CmsitemsApi();
        String catalogId = catalogId_example; // String | The catalog id
        String catalogVersion = catalogVersion_example; // String | CatalogVersion on which to search
        CMSItemSearch cmsItemSearchInfo = ; // CMSItemSearch | CMS Item search DTO
        String currentPage = currentPage_example; // String | The current result page requested
        String pageSize = pageSize_example; // String | Page size for paging
        Pageable pageableInfo = ; // Pageable | Pageable DTO
        String siteId = siteId_example; // String | The site identifier
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response
        String itemSearchParams = itemSearchParams_example; // String | Search on additional fields using a comma separated list of field name and value pairs which are separated by a colon. Exact matches only. You can use {@code null} as value.
        String mask = mask_example; // String | Search mask applied to the UID and NAME fields, Uses partial matching
        String sort = sort_example; // String | The requested ordering for the search results.
        String typeCode = typeCode_example; // String | TypeCode filter. Exact matches only. Either typeCode or typeCodes can be set.
        String typeCodes = typeCodes_example; // String | Search using a comma separated list of type code. Either typeCode or typeCodes can be set.
        try {
            map['String', Object] result = apiInstance.getCMSItemByPagedSearch(catalogId, catalogVersion, cmsItemSearchInfo, currentPage, pageSize, pageableInfo, siteId, fields, itemSearchParams, mask, sort, typeCode, typeCodes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CmsitemsApi#getCMSItemByPagedSearch");
            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
String *catalogVersion = catalogVersion_example; // CatalogVersion on which to search
CMSItemSearch *cmsItemSearchInfo = ; // CMS Item search DTO
String *currentPage = currentPage_example; // The current result page requested
String *pageSize = pageSize_example; // Page size for paging
Pageable *pageableInfo = ; // Pageable DTO
String *siteId = siteId_example; // The site identifier
String *fields = fields_example; // Response configuration (list of fields, which should be returned in response (optional)
String *itemSearchParams = itemSearchParams_example; // Search on additional fields using a comma separated list of field name and value pairs which are separated by a colon. Exact matches only. You can use {@code null} as value. (optional)
String *mask = mask_example; // Search mask applied to the UID and NAME fields, Uses partial matching (optional)
String *sort = sort_example; // The requested ordering for the search results. (optional)
String *typeCode = typeCode_example; // TypeCode filter. Exact matches only. Either typeCode or typeCodes can be set. (optional)
String *typeCodes = typeCodes_example; // Search using a comma separated list of type code. Either typeCode or typeCodes can be set. (optional)

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

// Finds CMS items.
[apiInstance getCMSItemByPagedSearchWith:catalogId
    catalogVersion:catalogVersion
    cmsItemSearchInfo:cmsItemSearchInfo
    currentPage:currentPage
    pageSize:pageSize
    pageableInfo:pageableInfo
    siteId:siteId
    fields:fields
    itemSearchParams:itemSearchParams
    mask:mask
    sort:sort
    typeCode:typeCode
    typeCodes:typeCodes
              completionHandler: ^(map['String', Object] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.CmsitemsApi()
var catalogId = catalogId_example; // {{String}} The catalog id
var catalogVersion = catalogVersion_example; // {{String}} CatalogVersion on which to search
var cmsItemSearchInfo = ; // {{CMSItemSearch}} CMS Item search DTO
var currentPage = currentPage_example; // {{String}} The current result page requested
var pageSize = pageSize_example; // {{String}} Page size for paging
var pageableInfo = ; // {{Pageable}} Pageable DTO
var siteId = siteId_example; // {{String}} The site identifier
var opts = { 
  'fields': fields_example, // {{String}} Response configuration (list of fields, which should be returned in response
  'itemSearchParams': itemSearchParams_example, // {{String}} Search on additional fields using a comma separated list of field name and value pairs which are separated by a colon. Exact matches only. You can use {@code null} as value.
  'mask': mask_example, // {{String}} Search mask applied to the UID and NAME fields, Uses partial matching
  'sort': sort_example, // {{String}} The requested ordering for the search results.
  'typeCode': typeCode_example, // {{String}} TypeCode filter. Exact matches only. Either typeCode or typeCodes can be set.
  'typeCodes': typeCodes_example // {{String}} Search using a comma separated list of type code. Either typeCode or typeCodes can be set.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCMSItemByPagedSearch(catalogId, catalogVersion, cmsItemSearchInfo, currentPage, pageSize, pageableInfo, siteId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCMSItemByPagedSearchExample
    {
        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 CmsitemsApi();
            var catalogId = catalogId_example;  // String | The catalog id
            var catalogVersion = catalogVersion_example;  // String | CatalogVersion on which to search
            var cmsItemSearchInfo = new CMSItemSearch(); // CMSItemSearch | CMS Item search DTO
            var currentPage = currentPage_example;  // String | The current result page requested
            var pageSize = pageSize_example;  // String | Page size for paging
            var pageableInfo = new Pageable(); // Pageable | Pageable DTO
            var siteId = siteId_example;  // String | The site identifier
            var fields = fields_example;  // String | Response configuration (list of fields, which should be returned in response (optional) 
            var itemSearchParams = itemSearchParams_example;  // String | Search on additional fields using a comma separated list of field name and value pairs which are separated by a colon. Exact matches only. You can use {@code null} as value. (optional) 
            var mask = mask_example;  // String | Search mask applied to the UID and NAME fields, Uses partial matching (optional) 
            var sort = sort_example;  // String | The requested ordering for the search results. (optional) 
            var typeCode = typeCode_example;  // String | TypeCode filter. Exact matches only. Either typeCode or typeCodes can be set. (optional) 
            var typeCodes = typeCodes_example;  // String | Search using a comma separated list of type code. Either typeCode or typeCodes can be set. (optional) 

            try
            {
                // Finds CMS items.
                map['String', Object] result = apiInstance.getCMSItemByPagedSearch(catalogId, catalogVersion, cmsItemSearchInfo, currentPage, pageSize, pageableInfo, siteId, fields, itemSearchParams, mask, sort, typeCode, typeCodes);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CmsitemsApi.getCMSItemByPagedSearch: " + 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\ApiCmsitemsApi();
$catalogId = catalogId_example; // String | The catalog id
$catalogVersion = catalogVersion_example; // String | CatalogVersion on which to search
$cmsItemSearchInfo = ; // CMSItemSearch | CMS Item search DTO
$currentPage = currentPage_example; // String | The current result page requested
$pageSize = pageSize_example; // String | Page size for paging
$pageableInfo = ; // Pageable | Pageable DTO
$siteId = siteId_example; // String | The site identifier
$fields = fields_example; // String | Response configuration (list of fields, which should be returned in response
$itemSearchParams = itemSearchParams_example; // String | Search on additional fields using a comma separated list of field name and value pairs which are separated by a colon. Exact matches only. You can use {@code null} as value.
$mask = mask_example; // String | Search mask applied to the UID and NAME fields, Uses partial matching
$sort = sort_example; // String | The requested ordering for the search results.
$typeCode = typeCode_example; // String | TypeCode filter. Exact matches only. Either typeCode or typeCodes can be set.
$typeCodes = typeCodes_example; // String | Search using a comma separated list of type code. Either typeCode or typeCodes can be set.

try {
    $result = $api_instance->getCMSItemByPagedSearch($catalogId, $catalogVersion, $cmsItemSearchInfo, $currentPage, $pageSize, $pageableInfo, $siteId, $fields, $itemSearchParams, $mask, $sort, $typeCode, $typeCodes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CmsitemsApi->getCMSItemByPagedSearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CmsitemsApi;

# 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::CmsitemsApi->new();
my $catalogId = catalogId_example; # String | The catalog id
my $catalogVersion = catalogVersion_example; # String | CatalogVersion on which to search
my $cmsItemSearchInfo = ; # CMSItemSearch | CMS Item search DTO
my $currentPage = currentPage_example; # String | The current result page requested
my $pageSize = pageSize_example; # String | Page size for paging
my $pageableInfo = ; # Pageable | Pageable DTO
my $siteId = siteId_example; # String | The site identifier
my $fields = fields_example; # String | Response configuration (list of fields, which should be returned in response
my $itemSearchParams = itemSearchParams_example; # String | Search on additional fields using a comma separated list of field name and value pairs which are separated by a colon. Exact matches only. You can use {@code null} as value.
my $mask = mask_example; # String | Search mask applied to the UID and NAME fields, Uses partial matching
my $sort = sort_example; # String | The requested ordering for the search results.
my $typeCode = typeCode_example; # String | TypeCode filter. Exact matches only. Either typeCode or typeCodes can be set.
my $typeCodes = typeCodes_example; # String | Search using a comma separated list of type code. Either typeCode or typeCodes can be set.

eval { 
    my $result = $api_instance->getCMSItemByPagedSearch(catalogId => $catalogId, catalogVersion => $catalogVersion, cmsItemSearchInfo => $cmsItemSearchInfo, currentPage => $currentPage, pageSize => $pageSize, pageableInfo => $pageableInfo, siteId => $siteId, fields => $fields, itemSearchParams => $itemSearchParams, mask => $mask, sort => $sort, typeCode => $typeCode, typeCodes => $typeCodes);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CmsitemsApi->getCMSItemByPagedSearch: $@\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.CmsitemsApi()
catalogId = catalogId_example # String | The catalog id
catalogVersion = catalogVersion_example # String | CatalogVersion on which to search
cmsItemSearchInfo =  # CMSItemSearch | CMS Item search DTO
currentPage = currentPage_example # String | The current result page requested
pageSize = pageSize_example # String | Page size for paging
pageableInfo =  # Pageable | Pageable DTO
siteId = siteId_example # String | The site identifier
fields = fields_example # String | Response configuration (list of fields, which should be returned in response (optional)
itemSearchParams = itemSearchParams_example # String | Search on additional fields using a comma separated list of field name and value pairs which are separated by a colon. Exact matches only. You can use {@code null} as value. (optional)
mask = mask_example # String | Search mask applied to the UID and NAME fields, Uses partial matching (optional)
sort = sort_example # String | The requested ordering for the search results. (optional)
typeCode = typeCode_example # String | TypeCode filter. Exact matches only. Either typeCode or typeCodes can be set. (optional)
typeCodes = typeCodes_example # String | Search using a comma separated list of type code. Either typeCode or typeCodes can be set. (optional)

try: 
    # Finds CMS items.
    api_response = api_instance.get_cms_item_by_paged_search(catalogId, catalogVersion, cmsItemSearchInfo, currentPage, pageSize, pageableInfo, siteId, fields=fields, itemSearchParams=itemSearchParams, mask=mask, sort=sort, typeCode=typeCode, typeCodes=typeCodes)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CmsitemsApi->getCMSItemByPagedSearch: %s\n" % e)

Parameters

Path parameters
Name Description
siteId*
String
The site identifier
Required
Query parameters
Name Description
catalogId*
String
The catalog id
Required
catalogVersion*
String
CatalogVersion on which to search
Required
cmsItemSearchInfo*
CMSItemSearch
CMS Item search DTO
Required
currentPage*
String
The current result page requested
Required
fields
String
Response configuration (list of fields, which should be returned in response
itemSearchParams
String
Search on additional fields using a comma separated list of field name and value pairs which are separated by a colon. Exact matches only. You can use {@code null} as value.
mask
String
Search mask applied to the UID and NAME fields, Uses partial matching
pageSize*
String
Page size for paging
Required
pageableInfo*
Pageable
Pageable DTO
Required
sort
String
The requested ordering for the search results.
typeCode
String
TypeCode filter. Exact matches only. Either typeCode or typeCodes can be set.
typeCodes
String
Search using a comma separated list of type code. Either typeCode or typeCodes can be set.

Responses

Status: 200 - A map of paging info and results. Results are in the form of Map&lt;String, Object&gt;, each representing a CMSItem. Never null.

Status: 400 - If the required fields are missing (WebserviceValidationException).

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getCMSItemByUUIdAndVersion1

Gets CMS Item by uuid.

Retrieves an item that matches the given item uuid (Universally Unique Identifier).


/v1/sites/{siteId}/cmsitems/{uuid}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/sites/{siteId}/cmsitems/{uuid}?fields=&versionId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CmsitemsApi;

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

public class CmsitemsApiExample {

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

        CmsitemsApi apiInstance = new CmsitemsApi();
        String siteId = siteId_example; // String | The site identifier
        String uuid = uuid_example; // String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
        String versionId = versionId_example; // String | The uid of the cms version.
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
        try {
            map['String', Object] result = apiInstance.getCMSItemByUUIdAndVersion1(siteId, uuid, versionId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CmsitemsApi#getCMSItemByUUIdAndVersion1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CmsitemsApi;

public class CmsitemsApiExample {

    public static void main(String[] args) {
        CmsitemsApi apiInstance = new CmsitemsApi();
        String siteId = siteId_example; // String | The site identifier
        String uuid = uuid_example; // String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
        String versionId = versionId_example; // String | The uid of the cms version.
        String fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)
        try {
            map['String', Object] result = apiInstance.getCMSItemByUUIdAndVersion1(siteId, uuid, versionId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CmsitemsApi#getCMSItemByUUIdAndVersion1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *siteId = siteId_example; // The site identifier
String *uuid = uuid_example; // The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
String *versionId = versionId_example; // The uid of the cms version.
String *fields = fields_example; // Response configuration (list of fields, which should be returned in response) (optional)

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

// Gets CMS Item by uuid.
[apiInstance getCMSItemByUUIdAndVersion1With:siteId
    uuid:uuid
    versionId:versionId
    fields:fields
              completionHandler: ^(map['String', Object] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.CmsitemsApi()
var siteId = siteId_example; // {{String}} The site identifier
var uuid = uuid_example; // {{String}} The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
var versionId = versionId_example; // {{String}} The uid of the cms version.
var opts = { 
  'fields': fields_example // {{String}} Response configuration (list of fields, which should be returned in response)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCMSItemByUUIdAndVersion1(siteId, uuid, versionId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCMSItemByUUIdAndVersion1Example
    {
        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 CmsitemsApi();
            var siteId = siteId_example;  // String | The site identifier
            var uuid = uuid_example;  // String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
            var versionId = versionId_example;  // String | The uid of the cms version.
            var fields = fields_example;  // String | Response configuration (list of fields, which should be returned in response) (optional) 

            try
            {
                // Gets CMS Item by uuid.
                map['String', Object] result = apiInstance.getCMSItemByUUIdAndVersion1(siteId, uuid, versionId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CmsitemsApi.getCMSItemByUUIdAndVersion1: " + 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\ApiCmsitemsApi();
$siteId = siteId_example; // String | The site identifier
$uuid = uuid_example; // String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
$versionId = versionId_example; // String | The uid of the cms version.
$fields = fields_example; // String | Response configuration (list of fields, which should be returned in response)

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

# 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::CmsitemsApi->new();
my $siteId = siteId_example; # String | The site identifier
my $uuid = uuid_example; # String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
my $versionId = versionId_example; # String | The uid of the cms version.
my $fields = fields_example; # String | Response configuration (list of fields, which should be returned in response)

eval { 
    my $result = $api_instance->getCMSItemByUUIdAndVersion1(siteId => $siteId, uuid => $uuid, versionId => $versionId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CmsitemsApi->getCMSItemByUUIdAndVersion1: $@\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.CmsitemsApi()
siteId = siteId_example # String | The site identifier
uuid = uuid_example # String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
versionId = versionId_example # String | The uid of the cms version.
fields = fields_example # String | Response configuration (list of fields, which should be returned in response) (optional)

try: 
    # Gets CMS Item by uuid.
    api_response = api_instance.get_cms_item_by_uu_id_and_version1(siteId, uuid, versionId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CmsitemsApi->getCMSItemByUUIdAndVersion1: %s\n" % e)

Parameters

Path parameters
Name Description
siteId*
String
The site identifier
Required
uuid*
String
The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
Required
Query parameters
Name Description
fields
String
Response configuration (list of fields, which should be returned in response)
versionId*
String
The uid of the cms version.
Required

Responses

Status: 200 - Map&lt;String, Object&gt; representation of the CMS Item object.

Status: 400 - If there is any validation error (WebserviceValidationException).

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


removeCMSItemByUUId

Removes CMS Item.

Deletes a specific instance of the content item (CMSItem) from the system by uuid.


/v1/sites/{siteId}/cmsitems/{uuid}

Usage and SDK Samples

curl -X DELETE\
\
\
"http://localhost:9001/cmswebservices/v1/sites/{siteId}/cmsitems/{uuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CmsitemsApi;

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

public class CmsitemsApiExample {

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

        CmsitemsApi apiInstance = new CmsitemsApi();
        String siteId = siteId_example; // String | The site identifier
        String uuid = uuid_example; // String | The universally unique identifier of the item
        try {
            apiInstance.removeCMSItemByUUId(siteId, uuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CmsitemsApi#removeCMSItemByUUId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CmsitemsApi;

public class CmsitemsApiExample {

    public static void main(String[] args) {
        CmsitemsApi apiInstance = new CmsitemsApi();
        String siteId = siteId_example; // String | The site identifier
        String uuid = uuid_example; // String | The universally unique identifier of the item
        try {
            apiInstance.removeCMSItemByUUId(siteId, uuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling CmsitemsApi#removeCMSItemByUUId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *siteId = siteId_example; // The site identifier
String *uuid = uuid_example; // The universally unique identifier of the item

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

// Removes CMS Item.
[apiInstance removeCMSItemByUUIdWith:siteId
    uuid:uuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.CmsitemsApi()
var siteId = siteId_example; // {{String}} The site identifier
var uuid = uuid_example; // {{String}} The universally unique identifier of the item

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

namespace Example
{
    public class removeCMSItemByUUIdExample
    {
        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 CmsitemsApi();
            var siteId = siteId_example;  // String | The site identifier
            var uuid = uuid_example;  // String | The universally unique identifier of the item

            try
            {
                // Removes CMS Item.
                apiInstance.removeCMSItemByUUId(siteId, uuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CmsitemsApi.removeCMSItemByUUId: " + 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\ApiCmsitemsApi();
$siteId = siteId_example; // String | The site identifier
$uuid = uuid_example; // String | The universally unique identifier of the item

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

# 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::CmsitemsApi->new();
my $siteId = siteId_example; # String | The site identifier
my $uuid = uuid_example; # String | The universally unique identifier of the item

eval { 
    $api_instance->removeCMSItemByUUId(siteId => $siteId, uuid => $uuid);
};
if ($@) {
    warn "Exception when calling CmsitemsApi->removeCMSItemByUUId: $@\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.CmsitemsApi()
siteId = siteId_example # String | The site identifier
uuid = uuid_example # String | The universally unique identifier of the item

try: 
    # Removes CMS Item.
    api_instance.remove_cms_item_by_uu_id(siteId, uuid)
except ApiException as e:
    print("Exception when calling CmsitemsApi->removeCMSItemByUUId: %s\n" % e)

Parameters

Path parameters
Name Description
siteId*
String
The site identifier
Required
uuid*
String
The universally unique identifier of the item
Required

Responses

Status: 400 - If it cannot find the content item (CMSItemNotFoundException).

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


searchCMSItemByUUId

Finds cms items by uuids in body.

Retrieves a list of available CMSItems matching the given uuids by POSTing the uuids in the request body.


/v1/sites/{siteId}/cmsitems/uuids

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/cmswebservices/v1/sites/{siteId}/cmsitems/uuids"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CmsitemsApi;

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

public class CmsitemsApiExample {

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

        CmsitemsApi apiInstance = new CmsitemsApi();
        CMSItemUuidList body = ; // CMSItemUuidList | 
        String siteId = siteId_example; // String | The site identifier
        try {
            map['String', Object] result = apiInstance.searchCMSItemByUUId(body, siteId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CmsitemsApi#searchCMSItemByUUId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CmsitemsApi;

public class CmsitemsApiExample {

    public static void main(String[] args) {
        CmsitemsApi apiInstance = new CmsitemsApi();
        CMSItemUuidList body = ; // CMSItemUuidList | 
        String siteId = siteId_example; // String | The site identifier
        try {
            map['String', Object] result = apiInstance.searchCMSItemByUUId(body, siteId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CmsitemsApi#searchCMSItemByUUId");
            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"];
CMSItemUuidList *body = ; // 
String *siteId = siteId_example; // The site identifier

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

// Finds cms items by uuids in body.
[apiInstance searchCMSItemByUUIdWith:body
    siteId:siteId
              completionHandler: ^(map['String', Object] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.CmsitemsApi()
var body = ; // {{CMSItemUuidList}} 
var siteId = siteId_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.searchCMSItemByUUId(bodysiteId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchCMSItemByUUIdExample
    {
        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 CmsitemsApi();
            var body = new CMSItemUuidList(); // CMSItemUuidList | 
            var siteId = siteId_example;  // String | The site identifier

            try
            {
                // Finds cms items by uuids in body.
                map['String', Object] result = apiInstance.searchCMSItemByUUId(body, siteId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CmsitemsApi.searchCMSItemByUUId: " + 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\ApiCmsitemsApi();
$body = ; // CMSItemUuidList | 
$siteId = siteId_example; // String | The site identifier

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

# 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::CmsitemsApi->new();
my $body = WWW::SwaggerClient::Object::CMSItemUuidList->new(); # CMSItemUuidList | 
my $siteId = siteId_example; # String | The site identifier

eval { 
    my $result = $api_instance->searchCMSItemByUUId(body => $body, siteId => $siteId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CmsitemsApi->searchCMSItemByUUId: $@\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.CmsitemsApi()
body =  # CMSItemUuidList | 
siteId = siteId_example # String | The site identifier

try: 
    # Finds cms items by uuids in body.
    api_response = api_instance.search_cms_item_by_uu_id(body, siteId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CmsitemsApi->searchCMSItemByUUId: %s\n" % e)

Parameters

Path parameters
Name Description
siteId*
String
The site identifier
Required
Body parameters
Name Description
body *

Responses

Status: 200 - A map list of elements in the form of Map&lt;String, Object&gt;, each representing a CMSItem.

Status: 400 - If it cannot find one of the items (CMSItemNotFoundException).

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


validateCMSItemForCreation1

Validates CMS Item for creation.

Performs validation on the specific instance of the CMS Item in a Dry Run mode.


/v1/sites/{siteId}/cmsitems

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/cmswebservices/v1/sites/{siteId}/cmsitems?dryRun="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CmsitemsApi;

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

public class CmsitemsApiExample {

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

        CmsitemsApi apiInstance = new CmsitemsApi();
        map[String, Object] body = ; // map[String, Object] | 
        Boolean dryRun = true; // Boolean | When set to TRUE, the request is executed in Dry Run mode
        String siteId = siteId_example; // String | The site identifier
        try {
            map['String', Object] result = apiInstance.validateCMSItemForCreation1(body, dryRun, siteId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CmsitemsApi#validateCMSItemForCreation1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CmsitemsApi;

public class CmsitemsApiExample {

    public static void main(String[] args) {
        CmsitemsApi apiInstance = new CmsitemsApi();
        map[String, Object] body = ; // map[String, Object] | 
        Boolean dryRun = true; // Boolean | When set to TRUE, the request is executed in Dry Run mode
        String siteId = siteId_example; // String | The site identifier
        try {
            map['String', Object] result = apiInstance.validateCMSItemForCreation1(body, dryRun, siteId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CmsitemsApi#validateCMSItemForCreation1");
            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"];
map[String, Object] *body = ; // 
Boolean *dryRun = true; // When set to TRUE, the request is executed in Dry Run mode
String *siteId = siteId_example; // The site identifier

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

// Validates CMS Item for creation.
[apiInstance validateCMSItemForCreation1With:body
    dryRun:dryRun
    siteId:siteId
              completionHandler: ^(map['String', Object] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.CmsitemsApi()
var body = ; // {{map[String, Object]}} 
var dryRun = true; // {{Boolean}} When set to TRUE, the request is executed in Dry Run mode
var siteId = siteId_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.validateCMSItemForCreation1(bodydryRunsiteId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class validateCMSItemForCreation1Example
    {
        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 CmsitemsApi();
            var body = new map[String, Object](); // map[String, Object] | 
            var dryRun = true;  // Boolean | When set to TRUE, the request is executed in Dry Run mode
            var siteId = siteId_example;  // String | The site identifier

            try
            {
                // Validates CMS Item for creation.
                map['String', Object] result = apiInstance.validateCMSItemForCreation1(body, dryRun, siteId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CmsitemsApi.validateCMSItemForCreation1: " + 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\ApiCmsitemsApi();
$body = ; // map[String, Object] | 
$dryRun = true; // Boolean | When set to TRUE, the request is executed in Dry Run mode
$siteId = siteId_example; // String | The site identifier

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

# 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::CmsitemsApi->new();
my $body = WWW::SwaggerClient::Object::map[String, Object]->new(); # map[String, Object] | 
my $dryRun = true; # Boolean | When set to TRUE, the request is executed in Dry Run mode
my $siteId = siteId_example; # String | The site identifier

eval { 
    my $result = $api_instance->validateCMSItemForCreation1(body => $body, dryRun => $dryRun, siteId => $siteId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CmsitemsApi->validateCMSItemForCreation1: $@\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.CmsitemsApi()
body =  # map[String, Object] | 
dryRun = true # Boolean | When set to TRUE, the request is executed in Dry Run mode
siteId = siteId_example # String | The site identifier

try: 
    # Validates CMS Item for creation.
    api_response = api_instance.validate_cms_item_for_creation1(body, dryRun, siteId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CmsitemsApi->validateCMSItemForCreation1: %s\n" % e)

Parameters

Path parameters
Name Description
siteId*
String
The site identifier
Required
Body parameters
Name Description
body *
Query parameters
Name Description
dryRun*
Boolean
When set to TRUE, the request is executed in Dry Run mode
Required

Responses

Status: 200 - The multi-level Map representing the validated CMS Item.

Status: 201 - The multi-level Map representing the newly created CMS Item.

Status: 400 - If it cannot find the content item (CMSItemNotFoundException) or if there is any validation error (WebserviceValidationException).

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


validateCMSItemForUpdate1

Validates CMS Item for update.

Performs validation steps on a CMS Item in a Dry Run mod.


/v1/sites/{siteId}/cmsitems/{uuid}

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/cmswebservices/v1/sites/{siteId}/cmsitems/{uuid}?dryRun="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CmsitemsApi;

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

public class CmsitemsApiExample {

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

        CmsitemsApi apiInstance = new CmsitemsApi();
        map[String, Object] body = ; // map[String, Object] | 
        Boolean dryRun = true; // Boolean | When set to TRUE, the request is executed in Dry Run mode
        String siteId = siteId_example; // String | The site identifier
        String uuid = uuid_example; // String | Unique Identifier of a CMS Item
        try {
            map['String', Object] result = apiInstance.validateCMSItemForUpdate1(body, dryRun, siteId, uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CmsitemsApi#validateCMSItemForUpdate1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CmsitemsApi;

public class CmsitemsApiExample {

    public static void main(String[] args) {
        CmsitemsApi apiInstance = new CmsitemsApi();
        map[String, Object] body = ; // map[String, Object] | 
        Boolean dryRun = true; // Boolean | When set to TRUE, the request is executed in Dry Run mode
        String siteId = siteId_example; // String | The site identifier
        String uuid = uuid_example; // String | Unique Identifier of a CMS Item
        try {
            map['String', Object] result = apiInstance.validateCMSItemForUpdate1(body, dryRun, siteId, uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CmsitemsApi#validateCMSItemForUpdate1");
            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"];
map[String, Object] *body = ; // 
Boolean *dryRun = true; // When set to TRUE, the request is executed in Dry Run mode
String *siteId = siteId_example; // The site identifier
String *uuid = uuid_example; // Unique Identifier of a CMS Item

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

// Validates CMS Item for update.
[apiInstance validateCMSItemForUpdate1With:body
    dryRun:dryRun
    siteId:siteId
    uuid:uuid
              completionHandler: ^(map['String', Object] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.CmsitemsApi()
var body = ; // {{map[String, Object]}} 
var dryRun = true; // {{Boolean}} When set to TRUE, the request is executed in Dry Run mode
var siteId = siteId_example; // {{String}} The site identifier
var uuid = uuid_example; // {{String}} Unique Identifier of a CMS Item

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

namespace Example
{
    public class validateCMSItemForUpdate1Example
    {
        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 CmsitemsApi();
            var body = new map[String, Object](); // map[String, Object] | 
            var dryRun = true;  // Boolean | When set to TRUE, the request is executed in Dry Run mode
            var siteId = siteId_example;  // String | The site identifier
            var uuid = uuid_example;  // String | Unique Identifier of a CMS Item

            try
            {
                // Validates CMS Item for update.
                map['String', Object] result = apiInstance.validateCMSItemForUpdate1(body, dryRun, siteId, uuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CmsitemsApi.validateCMSItemForUpdate1: " + 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\ApiCmsitemsApi();
$body = ; // map[String, Object] | 
$dryRun = true; // Boolean | When set to TRUE, the request is executed in Dry Run mode
$siteId = siteId_example; // String | The site identifier
$uuid = uuid_example; // String | Unique Identifier of a CMS Item

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

# 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::CmsitemsApi->new();
my $body = WWW::SwaggerClient::Object::map[String, Object]->new(); # map[String, Object] | 
my $dryRun = true; # Boolean | When set to TRUE, the request is executed in Dry Run mode
my $siteId = siteId_example; # String | The site identifier
my $uuid = uuid_example; # String | Unique Identifier of a CMS Item

eval { 
    my $result = $api_instance->validateCMSItemForUpdate1(body => $body, dryRun => $dryRun, siteId => $siteId, uuid => $uuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CmsitemsApi->validateCMSItemForUpdate1: $@\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.CmsitemsApi()
body =  # map[String, Object] | 
dryRun = true # Boolean | When set to TRUE, the request is executed in Dry Run mode
siteId = siteId_example # String | The site identifier
uuid = uuid_example # String | Unique Identifier of a CMS Item

try: 
    # Validates CMS Item for update.
    api_response = api_instance.validate_cms_item_for_update1(body, dryRun, siteId, uuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CmsitemsApi->validateCMSItemForUpdate1: %s\n" % e)

Parameters

Path parameters
Name Description
siteId*
String
The site identifier
Required
uuid*
String
Unique Identifier of a CMS Item
Required
Body parameters
Name Description
body *
Query parameters
Name Description
dryRun*
Boolean
When set to TRUE, the request is executed in Dry Run mode
Required

Responses

Status: 200 - The multi-level Map representing the validated CMS Item.

Status: 400 - If it cannot find the content item (CMSItemNotFoundException) or if there is any validation error (WebserviceValidationException).

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


ItemSynchronization

doPerformSync

Performs synchronization.

Executes status synchronization on a list of ItemModel identifier by their ItemSynchronization properties.


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

Usage and SDK Samples

curl -X POST\
\
\
-H "Content-Type: application/json"\
"http://localhost:9001/cmswebservices/v1/sites/{siteId}/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.ItemSynchronizationApi;

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

public class ItemSynchronizationApiExample {

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

        ItemSynchronizationApi apiInstance = new ItemSynchronizationApi();
        Synchronization body = ; // Synchronization | 
        String catalogId = catalogId_example; // String | The source catalog version from a synchronization perspective
        String siteId = siteId_example; // String | The site identifier
        String targetCatalogVersion = targetCatalogVersion_example; // String | The SynchronizationWsDTO containing the list of requested synchronizations
        String versionId = versionId_example; // String | The target catalog version from a synchronization perspective
        try {
            apiInstance.doPerformSync(body, catalogId, siteId, targetCatalogVersion, versionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ItemSynchronizationApi#doPerformSync");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ItemSynchronizationApi;

public class ItemSynchronizationApiExample {

    public static void main(String[] args) {
        ItemSynchronizationApi apiInstance = new ItemSynchronizationApi();
        Synchronization body = ; // Synchronization | 
        String catalogId = catalogId_example; // String | The source catalog version from a synchronization perspective
        String siteId = siteId_example; // String | The site identifier
        String targetCatalogVersion = targetCatalogVersion_example; // String | The SynchronizationWsDTO containing the list of requested synchronizations
        String versionId = versionId_example; // String | The target catalog version from a synchronization perspective
        try {
            apiInstance.doPerformSync(body, catalogId, siteId, targetCatalogVersion, versionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ItemSynchronizationApi#doPerformSync");
            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 *catalogId = catalogId_example; // The source catalog version from a synchronization perspective
String *siteId = siteId_example; // The site identifier
String *targetCatalogVersion = targetCatalogVersion_example; // The SynchronizationWsDTO containing the list of requested synchronizations
String *versionId = versionId_example; // The target catalog version from a synchronization perspective

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

// Performs synchronization.
[apiInstance doPerformSyncWith:body
    catalogId:catalogId
    siteId:siteId
    targetCatalogVersion:targetCatalogVersion
    versionId:versionId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.ItemSynchronizationApi()
var body = ; // {{Synchronization}} 
var catalogId = catalogId_example; // {{String}} The source catalog version from a synchronization perspective
var siteId = siteId_example; // {{String}} The site identifier
var targetCatalogVersion = targetCatalogVersion_example; // {{String}} The SynchronizationWsDTO containing the list of requested synchronizations
var versionId = versionId_example; // {{String}} The target catalog version from a synchronization perspective

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

namespace Example
{
    public class doPerformSyncExample
    {
        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 ItemSynchronizationApi();
            var body = new Synchronization(); // Synchronization | 
            var catalogId = catalogId_example;  // String | The source catalog version from a synchronization perspective
            var siteId = siteId_example;  // String | The site identifier
            var targetCatalogVersion = targetCatalogVersion_example;  // String | The SynchronizationWsDTO containing the list of requested synchronizations
            var versionId = versionId_example;  // String | The target catalog version from a synchronization perspective

            try
            {
                // Performs synchronization.
                apiInstance.doPerformSync(body, catalogId, siteId, targetCatalogVersion, versionId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ItemSynchronizationApi.doPerformSync: " + 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\ApiItemSynchronizationApi();
$body = ; // Synchronization | 
$catalogId = catalogId_example; // String | The source catalog version from a synchronization perspective
$siteId = siteId_example; // String | The site identifier
$targetCatalogVersion = targetCatalogVersion_example; // String | The SynchronizationWsDTO containing the list of requested synchronizations
$versionId = versionId_example; // String | The target catalog version from a synchronization perspective

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

# 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::ItemSynchronizationApi->new();
my $body = WWW::SwaggerClient::Object::Synchronization->new(); # Synchronization | 
my $catalogId = catalogId_example; # String | The source catalog version from a synchronization perspective
my $siteId = siteId_example; # String | The site identifier
my $targetCatalogVersion = targetCatalogVersion_example; # String | The SynchronizationWsDTO containing the list of requested synchronizations
my $versionId = versionId_example; # String | The target catalog version from a synchronization perspective

eval { 
    $api_instance->doPerformSync(body => $body, catalogId => $catalogId, siteId => $siteId, targetCatalogVersion => $targetCatalogVersion, versionId => $versionId);
};
if ($@) {
    warn "Exception when calling ItemSynchronizationApi->doPerformSync: $@\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.ItemSynchronizationApi()
body =  # Synchronization | 
catalogId = catalogId_example # String | The source catalog version from a synchronization perspective
siteId = siteId_example # String | The site identifier
targetCatalogVersion = targetCatalogVersion_example # String | The SynchronizationWsDTO containing the list of requested synchronizations
versionId = versionId_example # String | The target catalog version from a synchronization perspective

try: 
    # Performs synchronization.
    api_instance.do_perform_sync(body, catalogId, siteId, targetCatalogVersion, versionId)
except ApiException as e:
    print("Exception when calling ItemSynchronizationApi->doPerformSync: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The source catalog version from a synchronization perspective
Required
siteId*
String
The site identifier
Required
targetCatalogVersion*
String
The SynchronizationWsDTO containing the list of requested synchronizations
Required
versionId*
String
The target 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


getComponentSynchronizationStatus

Gets component synchronization status.

Builds the synchronization status of a AbstractCMSComponentModel component.


/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/synchronizations/versions/{targetCatalogVersion}/items/{componentId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/synchronizations/versions/{targetCatalogVersion}/items/{componentId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ItemSynchronizationApi;

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

public class ItemSynchronizationApiExample {

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

        ItemSynchronizationApi apiInstance = new ItemSynchronizationApi();
        String catalogId = catalogId_example; // String | The catalog id
        String componentId = componentId_example; // String | The uid of the component from which to retrieve the synchronization status
        String siteId = siteId_example; // String | The site identifier
        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.getComponentSynchronizationStatus(catalogId, componentId, siteId, targetCatalogVersion, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ItemSynchronizationApi#getComponentSynchronizationStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ItemSynchronizationApi;

public class ItemSynchronizationApiExample {

    public static void main(String[] args) {
        ItemSynchronizationApi apiInstance = new ItemSynchronizationApi();
        String catalogId = catalogId_example; // String | The catalog id
        String componentId = componentId_example; // String | The uid of the component from which to retrieve the synchronization status
        String siteId = siteId_example; // String | The site identifier
        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.getComponentSynchronizationStatus(catalogId, componentId, siteId, targetCatalogVersion, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ItemSynchronizationApi#getComponentSynchronizationStatus");
            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
String *componentId = componentId_example; // The uid of the component from which to retrieve the synchronization status
String *siteId = siteId_example; // The site identifier
String *targetCatalogVersion = targetCatalogVersion_example; // The target catalog version from a synchronization perspective
String *versionId = versionId_example; // The source catalog version from a synchronization perspective

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

// Gets component synchronization status.
[apiInstance getComponentSynchronizationStatusWith:catalogId
    componentId:componentId
    siteId:siteId
    targetCatalogVersion:targetCatalogVersion
    versionId:versionId
              completionHandler: ^(SyncItemStatus output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.ItemSynchronizationApi()
var catalogId = catalogId_example; // {{String}} The catalog id
var componentId = componentId_example; // {{String}} The uid of the component from which to retrieve the synchronization status
var siteId = siteId_example; // {{String}} The site identifier
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.getComponentSynchronizationStatus(catalogId, componentId, siteId, targetCatalogVersion, versionId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getComponentSynchronizationStatusExample
    {
        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 ItemSynchronizationApi();
            var catalogId = catalogId_example;  // String | The catalog id
            var componentId = componentId_example;  // String | The uid of the component from which to retrieve the synchronization status
            var siteId = siteId_example;  // String | The site identifier
            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
            {
                // Gets component synchronization status.
                SyncItemStatus result = apiInstance.getComponentSynchronizationStatus(catalogId, componentId, siteId, targetCatalogVersion, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ItemSynchronizationApi.getComponentSynchronizationStatus: " + 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\ApiItemSynchronizationApi();
$catalogId = catalogId_example; // String | The catalog id
$componentId = componentId_example; // String | The uid of the component from which to retrieve the synchronization status
$siteId = siteId_example; // String | The site identifier
$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->getComponentSynchronizationStatus($catalogId, $componentId, $siteId, $targetCatalogVersion, $versionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ItemSynchronizationApi->getComponentSynchronizationStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ItemSynchronizationApi;

# 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::ItemSynchronizationApi->new();
my $catalogId = catalogId_example; # String | The catalog id
my $componentId = componentId_example; # String | The uid of the component from which to retrieve the synchronization status
my $siteId = siteId_example; # String | The site identifier
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->getComponentSynchronizationStatus(catalogId => $catalogId, componentId => $componentId, siteId => $siteId, targetCatalogVersion => $targetCatalogVersion, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ItemSynchronizationApi->getComponentSynchronizationStatus: $@\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.ItemSynchronizationApi()
catalogId = catalogId_example # String | The catalog id
componentId = componentId_example # String | The uid of the component from which to retrieve the synchronization status
siteId = siteId_example # String | The site identifier
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: 
    # Gets component synchronization status.
    api_response = api_instance.get_component_synchronization_status(catalogId, componentId, siteId, targetCatalogVersion, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemSynchronizationApi->getComponentSynchronizationStatus: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog id
Required
componentId*
String
The uid of the component from which to retrieve the synchronization status
Required
siteId*
String
The site identifier
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 AbstractCMSComponentModel page

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getPageSynchronizationStatus

Gets page synchronization status.

Builds the synchronization status of a AbstractPageModel page.


/v1/sites/{siteId}/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/cmswebservices/v1/sites/{siteId}/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.ItemSynchronizationApi;

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

public class ItemSynchronizationApiExample {

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

        ItemSynchronizationApi apiInstance = new ItemSynchronizationApi();
        String catalogId = catalogId_example; // String | The catalog id
        String pageId = pageId_example; // String | The uid of the page from which to retrieve the synchronization status
        String siteId = siteId_example; // String | The site identifier
        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.getPageSynchronizationStatus(catalogId, pageId, siteId, targetCatalogVersion, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ItemSynchronizationApi#getPageSynchronizationStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ItemSynchronizationApi;

public class ItemSynchronizationApiExample {

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

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

// Gets page synchronization status.
[apiInstance getPageSynchronizationStatusWith:catalogId
    pageId:pageId
    siteId:siteId
    targetCatalogVersion:targetCatalogVersion
    versionId:versionId
              completionHandler: ^(SyncItemStatus output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.ItemSynchronizationApi()
var catalogId = catalogId_example; // {{String}} The catalog id
var pageId = pageId_example; // {{String}} The uid of the page from which to retrieve the synchronization status
var siteId = siteId_example; // {{String}} The site identifier
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.getPageSynchronizationStatus(catalogId, pageId, siteId, targetCatalogVersion, versionId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPageSynchronizationStatusExample
    {
        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 ItemSynchronizationApi();
            var catalogId = catalogId_example;  // String | The catalog id
            var pageId = pageId_example;  // String | The uid of the page from which to retrieve the synchronization status
            var siteId = siteId_example;  // String | The site identifier
            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
            {
                // Gets page synchronization status.
                SyncItemStatus result = apiInstance.getPageSynchronizationStatus(catalogId, pageId, siteId, targetCatalogVersion, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ItemSynchronizationApi.getPageSynchronizationStatus: " + 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\ApiItemSynchronizationApi();
$catalogId = catalogId_example; // String | The catalog id
$pageId = pageId_example; // String | The uid of the page from which to retrieve the synchronization status
$siteId = siteId_example; // String | The site identifier
$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->getPageSynchronizationStatus($catalogId, $pageId, $siteId, $targetCatalogVersion, $versionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ItemSynchronizationApi->getPageSynchronizationStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ItemSynchronizationApi;

# 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::ItemSynchronizationApi->new();
my $catalogId = catalogId_example; # String | The catalog id
my $pageId = pageId_example; # String | The uid of the page from which to retrieve the synchronization status
my $siteId = siteId_example; # String | The site identifier
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->getPageSynchronizationStatus(catalogId => $catalogId, pageId => $pageId, siteId => $siteId, targetCatalogVersion => $targetCatalogVersion, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ItemSynchronizationApi->getPageSynchronizationStatus: $@\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.ItemSynchronizationApi()
catalogId = catalogId_example # String | The catalog id
pageId = pageId_example # String | The uid of the page from which to retrieve the synchronization status
siteId = siteId_example # String | The site identifier
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: 
    # Gets page synchronization status.
    api_response = api_instance.get_page_synchronization_status(catalogId, pageId, siteId, targetCatalogVersion, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemSynchronizationApi->getPageSynchronizationStatus: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog id
Required
pageId*
String
The uid of the page from which to retrieve the synchronization status
Required
siteId*
String
The site identifier
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


getSlotSynchronizationStatus

Gets slot synchronization status.

Builds the synchronization status of a ContentSlotModel slot.


/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/synchronizations/versions/{targetCatalogVersion}/slots/{slotId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/synchronizations/versions/{targetCatalogVersion}/slots/{slotId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ItemSynchronizationApi;

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

public class ItemSynchronizationApiExample {

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

        ItemSynchronizationApi apiInstance = new ItemSynchronizationApi();
        String catalogId = catalogId_example; // String | The catalog id
        String siteId = siteId_example; // String | The site identifier
        String slotId = slotId_example; // String | The uid of the slot 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.getSlotSynchronizationStatus(catalogId, siteId, slotId, targetCatalogVersion, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ItemSynchronizationApi#getSlotSynchronizationStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ItemSynchronizationApi;

public class ItemSynchronizationApiExample {

    public static void main(String[] args) {
        ItemSynchronizationApi apiInstance = new ItemSynchronizationApi();
        String catalogId = catalogId_example; // String | The catalog id
        String siteId = siteId_example; // String | The site identifier
        String slotId = slotId_example; // String | The uid of the slot 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.getSlotSynchronizationStatus(catalogId, siteId, slotId, targetCatalogVersion, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ItemSynchronizationApi#getSlotSynchronizationStatus");
            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
String *siteId = siteId_example; // The site identifier
String *slotId = slotId_example; // The uid of the slot 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

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

// Gets slot synchronization status.
[apiInstance getSlotSynchronizationStatusWith:catalogId
    siteId:siteId
    slotId:slotId
    targetCatalogVersion:targetCatalogVersion
    versionId:versionId
              completionHandler: ^(SyncItemStatus output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.ItemSynchronizationApi()
var catalogId = catalogId_example; // {{String}} The catalog id
var siteId = siteId_example; // {{String}} The site identifier
var slotId = slotId_example; // {{String}} The uid of the slot 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.getSlotSynchronizationStatus(catalogId, siteId, slotId, targetCatalogVersion, versionId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSlotSynchronizationStatusExample
    {
        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 ItemSynchronizationApi();
            var catalogId = catalogId_example;  // String | The catalog id
            var siteId = siteId_example;  // String | The site identifier
            var slotId = slotId_example;  // String | The uid of the slot 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
            {
                // Gets slot synchronization status.
                SyncItemStatus result = apiInstance.getSlotSynchronizationStatus(catalogId, siteId, slotId, targetCatalogVersion, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ItemSynchronizationApi.getSlotSynchronizationStatus: " + 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\ApiItemSynchronizationApi();
$catalogId = catalogId_example; // String | The catalog id
$siteId = siteId_example; // String | The site identifier
$slotId = slotId_example; // String | The uid of the slot 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->getSlotSynchronizationStatus($catalogId, $siteId, $slotId, $targetCatalogVersion, $versionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ItemSynchronizationApi->getSlotSynchronizationStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ItemSynchronizationApi;

# 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::ItemSynchronizationApi->new();
my $catalogId = catalogId_example; # String | The catalog id
my $siteId = siteId_example; # String | The site identifier
my $slotId = slotId_example; # String | The uid of the slot 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->getSlotSynchronizationStatus(catalogId => $catalogId, siteId => $siteId, slotId => $slotId, targetCatalogVersion => $targetCatalogVersion, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ItemSynchronizationApi->getSlotSynchronizationStatus: $@\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.ItemSynchronizationApi()
catalogId = catalogId_example # String | The catalog id
siteId = siteId_example # String | The site identifier
slotId = slotId_example # String | The uid of the slot 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: 
    # Gets slot synchronization status.
    api_response = api_instance.get_slot_synchronization_status(catalogId, siteId, slotId, targetCatalogVersion, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemSynchronizationApi->getSlotSynchronizationStatus: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog id
Required
siteId*
String
The site identifier
Required
slotId*
String
The uid of the slot 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 ContentSlotModel page

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


Languages

getLanguages

Gets languages.

Retrieves a list of available languages supported by a storefront.


/v1/sites/{siteId}/languages

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/sites/{siteId}/languages"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LanguagesApi;

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

public class LanguagesApiExample {

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

        LanguagesApi apiInstance = new LanguagesApi();
        String siteId = siteId_example; // String | The site identifier
        try {
            LanguageListData result = apiInstance.getLanguages(siteId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LanguagesApi#getLanguages");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LanguagesApi;

public class LanguagesApiExample {

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

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

// Gets languages.
[apiInstance getLanguagesWith:siteId
              completionHandler: ^(LanguageListData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.LanguagesApi()
var siteId = siteId_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.getLanguages(siteId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getLanguagesExample
    {
        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 LanguagesApi();
            var siteId = siteId_example;  // String | The site identifier

            try
            {
                // Gets languages.
                LanguageListData result = apiInstance.getLanguages(siteId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LanguagesApi.getLanguages: " + 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\ApiLanguagesApi();
$siteId = siteId_example; // String | The site identifier

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

# 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::LanguagesApi->new();
my $siteId = siteId_example; # String | The site identifier

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

try: 
    # Gets languages.
    api_response = api_instance.get_languages(siteId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LanguagesApi->getLanguages: %s\n" % e)

Parameters

Path parameters
Name Description
siteId*
String
The site identifier
Required

Responses

Status: 200 - List of languages.

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


Media

getMediaByQuery

Gets media by query.

Gets a specific media item by named query.


/v1/media

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/media?currentPage=&namedQuery=&pageSize=¶ms=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MediaApi;

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

public class MediaApiExample {

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

        MediaApi apiInstance = new MediaApi();
        String namedQuery = namedQuery_example; // String | The name of the named query to use for the search.
        String pageSize = pageSize_example; // String | The number of results per page.
        String params = params_example; // String | The list of the filtering parameters for the namedQuery.
Ex:"catalogId:catalogIdValue,catalogVersion:catalogVersionValue,code:codeValue"
        String sort = sort_example; // String | The requested ordering for the search results.
        String currentPage = currentPage_example; // String | The index of the requested page (index 0 means page 1).
        try {
            MediaListData result = apiInstance.getMediaByQuery(namedQuery, pageSize, params, sort, currentPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaApi#getMediaByQuery");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MediaApi;

public class MediaApiExample {

    public static void main(String[] args) {
        MediaApi apiInstance = new MediaApi();
        String namedQuery = namedQuery_example; // String | The name of the named query to use for the search.
        String pageSize = pageSize_example; // String | The number of results per page.
        String params = params_example; // String | The list of the filtering parameters for the namedQuery.
Ex:"catalogId:catalogIdValue,catalogVersion:catalogVersionValue,code:codeValue"
        String sort = sort_example; // String | The requested ordering for the search results.
        String currentPage = currentPage_example; // String | The index of the requested page (index 0 means page 1).
        try {
            MediaListData result = apiInstance.getMediaByQuery(namedQuery, pageSize, params, sort, currentPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaApi#getMediaByQuery");
            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 *namedQuery = namedQuery_example; // The name of the named query to use for the search.
String *pageSize = pageSize_example; // The number of results per page.
String *params = params_example; // The list of the filtering parameters for the namedQuery.
Ex:"catalogId:catalogIdValue,catalogVersion:catalogVersionValue,code:codeValue"
String *sort = sort_example; // The requested ordering for the search results.
String *currentPage = currentPage_example; // The index of the requested page (index 0 means page 1). (optional)

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

// Gets media by query.
[apiInstance getMediaByQueryWith:namedQuery
    pageSize:pageSize
    params:params
    sort:sort
    currentPage:currentPage
              completionHandler: ^(MediaListData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.MediaApi()
var namedQuery = namedQuery_example; // {{String}} The name of the named query to use for the search.
var pageSize = pageSize_example; // {{String}} The number of results per page.
var params = params_example; // {{String}} The list of the filtering parameters for the namedQuery.
Ex:"catalogId:catalogIdValue,catalogVersion:catalogVersionValue,code:codeValue"
var sort = sort_example; // {{String}} The requested ordering for the search results.
var opts = { 
  'currentPage': currentPage_example // {{String}} The index of the requested page (index 0 means page 1).
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMediaByQuery(namedQuery, pageSize, params, sort, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMediaByQueryExample
    {
        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 MediaApi();
            var namedQuery = namedQuery_example;  // String | The name of the named query to use for the search.
            var pageSize = pageSize_example;  // String | The number of results per page.
            var params = params_example;  // String | The list of the filtering parameters for the namedQuery.
Ex:"catalogId:catalogIdValue,catalogVersion:catalogVersionValue,code:codeValue"
            var sort = sort_example;  // String | The requested ordering for the search results.
            var currentPage = currentPage_example;  // String | The index of the requested page (index 0 means page 1). (optional) 

            try
            {
                // Gets media by query.
                MediaListData result = apiInstance.getMediaByQuery(namedQuery, pageSize, params, sort, currentPage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MediaApi.getMediaByQuery: " + 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\ApiMediaApi();
$namedQuery = namedQuery_example; // String | The name of the named query to use for the search.
$pageSize = pageSize_example; // String | The number of results per page.
$params = params_example; // String | The list of the filtering parameters for the namedQuery.
Ex:"catalogId:catalogIdValue,catalogVersion:catalogVersionValue,code:codeValue"
$sort = sort_example; // String | The requested ordering for the search results.
$currentPage = currentPage_example; // String | The index of the requested page (index 0 means page 1).

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

# 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::MediaApi->new();
my $namedQuery = namedQuery_example; # String | The name of the named query to use for the search.
my $pageSize = pageSize_example; # String | The number of results per page.
my $params = params_example; # String | The list of the filtering parameters for the namedQuery.
Ex:"catalogId:catalogIdValue,catalogVersion:catalogVersionValue,code:codeValue"
my $sort = sort_example; # String | The requested ordering for the search results.
my $currentPage = currentPage_example; # String | The index of the requested page (index 0 means page 1).

eval { 
    my $result = $api_instance->getMediaByQuery(namedQuery => $namedQuery, pageSize => $pageSize, params => $params, sort => $sort, currentPage => $currentPage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MediaApi->getMediaByQuery: $@\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.MediaApi()
namedQuery = namedQuery_example # String | The name of the named query to use for the search.
pageSize = pageSize_example # String | The number of results per page.
params = params_example # String | The list of the filtering parameters for the namedQuery.
Ex:"catalogId:catalogIdValue,catalogVersion:catalogVersionValue,code:codeValue"
sort = sort_example # String | The requested ordering for the search results.
currentPage = currentPage_example # String | The index of the requested page (index 0 means page 1). (optional)

try: 
    # Gets media by query.
    api_response = api_instance.get_media_by_query(namedQuery, pageSize, params, sort, currentPage=currentPage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MediaApi->getMediaByQuery: %s\n" % e)

Parameters

Query parameters
Name Description
currentPage
String
The index of the requested page (index 0 means page 1).
namedQuery*
String
The name of the named query to use for the search.
Required
pageSize*
String
The number of results per page.
Required
params*
String
The list of the filtering parameters for the namedQuery. Ex:"catalogId:catalogIdValue,catalogVersion:catalogVersionValue,code:codeValue"
Required
sort*
String
The requested ordering for the search results.
Required

Responses

Status: 200 - A single page of query results as a list of media or an empty list (WebserviceValidationException).

Status: 400 - When the named query parameters provide contain validation errors

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getMediaByUuid

Gets media by uuid.

Finds a specific media item that matches given uuid.


/v1/media/{uuid}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/media/{uuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MediaApi;

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

public class MediaApiExample {

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

        MediaApi apiInstance = new MediaApi();
        String uuid = uuid_example; // String | The universally unique identifier of the media item
        try {
            MediaData result = apiInstance.getMediaByUuid(uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaApi#getMediaByUuid");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MediaApi;

public class MediaApiExample {

    public static void main(String[] args) {
        MediaApi apiInstance = new MediaApi();
        String uuid = uuid_example; // String | The universally unique identifier of the media item
        try {
            MediaData result = apiInstance.getMediaByUuid(uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaApi#getMediaByUuid");
            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 *uuid = uuid_example; // The universally unique identifier of the media item

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

// Gets media by uuid.
[apiInstance getMediaByUuidWith:uuid
              completionHandler: ^(MediaData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.MediaApi()
var uuid = uuid_example; // {{String}} The universally unique identifier of the media item

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

namespace Example
{
    public class getMediaByUuidExample
    {
        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 MediaApi();
            var uuid = uuid_example;  // String | The universally unique identifier of the media item

            try
            {
                // Gets media by uuid.
                MediaData result = apiInstance.getMediaByUuid(uuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MediaApi.getMediaByUuid: " + 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\ApiMediaApi();
$uuid = uuid_example; // String | The universally unique identifier of the media item

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

# 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::MediaApi->new();
my $uuid = uuid_example; # String | The universally unique identifier of the media item

eval { 
    my $result = $api_instance->getMediaByUuid(uuid => $uuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MediaApi->getMediaByUuid: $@\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.MediaApi()
uuid = uuid_example # String | The universally unique identifier of the media item

try: 
    # Gets media by uuid.
    api_response = api_instance.get_media_by_uuid(uuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MediaApi->getMediaByUuid: %s\n" % e)

Parameters

Path parameters
Name Description
uuid*
String
The universally unique identifier of the media item
Required

Responses

Status: 200 - Media data

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - When no media is found matching the given uuid (MediaNotFoundException).


getMediaByUuids

Gets a list of media by uuids.

Retrieves a list of media items that match the given uuids by POSTing the uuids in the request body


/v1/media/uuids

Usage and SDK Samples

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

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

public class MediaApiExample {

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

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

public class MediaApiExample {

    public static void main(String[] args) {
        MediaApi apiInstance = new MediaApi();
        CMSItemUuidList body = ; // CMSItemUuidList | 
        try {
            MediaListData result = apiInstance.getMediaByUuids(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaApi#getMediaByUuids");
            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"];
CMSItemUuidList *body = ; // 

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

// Gets a list of media by uuids.
[apiInstance getMediaByUuidsWith:body
              completionHandler: ^(MediaListData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.MediaApi()
var body = ; // {{CMSItemUuidList}} 

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

namespace Example
{
    public class getMediaByUuidsExample
    {
        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 MediaApi();
            var body = new CMSItemUuidList(); // CMSItemUuidList | 

            try
            {
                // Gets a list of media by uuids.
                MediaListData result = apiInstance.getMediaByUuids(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MediaApi.getMediaByUuids: " + 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\ApiMediaApi();
$body = ; // CMSItemUuidList | 

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

# 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::MediaApi->new();
my $body = WWW::SwaggerClient::Object::CMSItemUuidList->new(); # CMSItemUuidList | 

eval { 
    my $result = $api_instance->getMediaByUuids(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MediaApi->getMediaByUuids: $@\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.MediaApi()
body =  # CMSItemUuidList | 

try: 
    # Gets a list of media by uuids.
    api_response = api_instance.get_media_by_uuids(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MediaApi->getMediaByUuids: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - A list of media data

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - When one of the media cannot be found (MediaNotFoundException).


MediaContainers

getMediaContainerByCode

Gets media container by code.

Retrieves a specific media container that matches the given id.


/v1/catalogs/{catalogId}/versions/{versionId}/mediacontainers/{code}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/catalogs/{catalogId}/versions/{versionId}/mediacontainers/{code}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MediaContainersApi;

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

public class MediaContainersApiExample {

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

        MediaContainersApi apiInstance = new MediaContainersApi();
        String catalogId = catalogId_example; // String | The catalog id
        String code = code_example; // String | The unique identifier of the media container
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            MediaContainer result = apiInstance.getMediaContainerByCode(catalogId, code, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaContainersApi#getMediaContainerByCode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MediaContainersApi;

public class MediaContainersApiExample {

    public static void main(String[] args) {
        MediaContainersApi apiInstance = new MediaContainersApi();
        String catalogId = catalogId_example; // String | The catalog id
        String code = code_example; // String | The unique identifier of the media container
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            MediaContainer result = apiInstance.getMediaContainerByCode(catalogId, code, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaContainersApi#getMediaContainerByCode");
            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
String *code = code_example; // The unique identifier of the media container
String *versionId = versionId_example; // The catalog version identifier

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

// Gets media container by code.
[apiInstance getMediaContainerByCodeWith:catalogId
    code:code
    versionId:versionId
              completionHandler: ^(MediaContainer output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.MediaContainersApi()
var catalogId = catalogId_example; // {{String}} The catalog id
var code = code_example; // {{String}} The unique identifier of the media container
var versionId = versionId_example; // {{String}} The catalog version identifier

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

namespace Example
{
    public class getMediaContainerByCodeExample
    {
        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 MediaContainersApi();
            var catalogId = catalogId_example;  // String | The catalog id
            var code = code_example;  // String | The unique identifier of the media container
            var versionId = versionId_example;  // String | The catalog version identifier

            try
            {
                // Gets media container by code.
                MediaContainer result = apiInstance.getMediaContainerByCode(catalogId, code, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MediaContainersApi.getMediaContainerByCode: " + 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\ApiMediaContainersApi();
$catalogId = catalogId_example; // String | The catalog id
$code = code_example; // String | The unique identifier of the media container
$versionId = versionId_example; // String | The catalog version identifier

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

# 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::MediaContainersApi->new();
my $catalogId = catalogId_example; # String | The catalog id
my $code = code_example; # String | The unique identifier of the media container
my $versionId = versionId_example; # String | The catalog version identifier

eval { 
    my $result = $api_instance->getMediaContainerByCode(catalogId => $catalogId, code => $code, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MediaContainersApi->getMediaContainerByCode: $@\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.MediaContainersApi()
catalogId = catalogId_example # String | The catalog id
code = code_example # String | The unique identifier of the media container
versionId = versionId_example # String | The catalog version identifier

try: 
    # Gets media container by code.
    api_response = api_instance.get_media_container_by_code(catalogId, code, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MediaContainersApi->getMediaContainerByCode: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog id
Required
code*
String
The unique identifier of the media container
Required
versionId*
String
The catalog version identifier
Required

Responses

Status: 200 - MediaContainerWsDTO

Status: 400 - When the media container was not found (CMSItemNotFoundException) or when there was a problem during conversion (ConversionException).

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getMediaContainersByText

Finds media container by partial to full code matching.

Retrieves a list of available media containers using a free text search field.


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

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/catalogs/{catalogId}/versions/{versionId}/mediacontainers?currentPage=&mask=&pageSize=&pageableInfo=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MediaContainersApi;

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

public class MediaContainersApiExample {

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

        MediaContainersApi apiInstance = new MediaContainersApi();
        String catalogId = catalogId_example; // String | The catalog id
        String pageSize = pageSize_example; // String | The maximum number of elements in the result list.
        Pageable pageableInfo = ; // Pageable | PageableWsDTO
        String versionId = versionId_example; // String | The catalog version identifier
        String currentPage = currentPage_example; // String | The requested page number
        String mask = mask_example; // String | The string value on which media containers will be filtered
        String sort = sort_example; // String | The string field the results will be sorted with
        try {
            MediaContainerList result = apiInstance.getMediaContainersByText(catalogId, pageSize, pageableInfo, versionId, currentPage, mask, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaContainersApi#getMediaContainersByText");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MediaContainersApi;

public class MediaContainersApiExample {

    public static void main(String[] args) {
        MediaContainersApi apiInstance = new MediaContainersApi();
        String catalogId = catalogId_example; // String | The catalog id
        String pageSize = pageSize_example; // String | The maximum number of elements in the result list.
        Pageable pageableInfo = ; // Pageable | PageableWsDTO
        String versionId = versionId_example; // String | The catalog version identifier
        String currentPage = currentPage_example; // String | The requested page number
        String mask = mask_example; // String | The string value on which media containers will be filtered
        String sort = sort_example; // String | The string field the results will be sorted with
        try {
            MediaContainerList result = apiInstance.getMediaContainersByText(catalogId, pageSize, pageableInfo, versionId, currentPage, mask, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaContainersApi#getMediaContainersByText");
            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
String *pageSize = pageSize_example; // The maximum number of elements in the result list.
Pageable *pageableInfo = ; // PageableWsDTO
String *versionId = versionId_example; // The catalog version identifier
String *currentPage = currentPage_example; // The requested page number (optional)
String *mask = mask_example; // The string value on which media containers will be filtered (optional)
String *sort = sort_example; // The string field the results will be sorted with (optional)

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

// Finds media container by partial to full code matching.
[apiInstance getMediaContainersByTextWith:catalogId
    pageSize:pageSize
    pageableInfo:pageableInfo
    versionId:versionId
    currentPage:currentPage
    mask:mask
    sort:sort
              completionHandler: ^(MediaContainerList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.MediaContainersApi()
var catalogId = catalogId_example; // {{String}} The catalog id
var pageSize = pageSize_example; // {{String}} The maximum number of elements in the result list.
var pageableInfo = ; // {{Pageable}} PageableWsDTO
var versionId = versionId_example; // {{String}} The catalog version identifier
var opts = { 
  'currentPage': currentPage_example, // {{String}} The requested page number
  'mask': mask_example, // {{String}} The string value on which media containers will be filtered
  '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.getMediaContainersByText(catalogId, 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 getMediaContainersByTextExample
    {
        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 MediaContainersApi();
            var catalogId = catalogId_example;  // String | The catalog id
            var pageSize = pageSize_example;  // String | The maximum number of elements in the result list.
            var pageableInfo = new Pageable(); // Pageable | PageableWsDTO
            var versionId = versionId_example;  // String | The catalog version identifier
            var currentPage = currentPage_example;  // String | The requested page number (optional) 
            var mask = mask_example;  // String | The string value on which media containers will be filtered (optional) 
            var sort = sort_example;  // String | The string field the results will be sorted with (optional) 

            try
            {
                // Finds media container by partial to full code matching.
                MediaContainerList result = apiInstance.getMediaContainersByText(catalogId, pageSize, pageableInfo, versionId, currentPage, mask, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MediaContainersApi.getMediaContainersByText: " + 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\ApiMediaContainersApi();
$catalogId = catalogId_example; // String | The catalog id
$pageSize = pageSize_example; // String | The maximum number of elements in the result list.
$pageableInfo = ; // Pageable | PageableWsDTO
$versionId = versionId_example; // String | The catalog version identifier
$currentPage = currentPage_example; // String | The requested page number
$mask = mask_example; // String | The string value on which media containers will be filtered
$sort = sort_example; // String | The string field the results will be sorted with

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

# 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::MediaContainersApi->new();
my $catalogId = catalogId_example; # String | The catalog id
my $pageSize = pageSize_example; # String | The maximum number of elements in the result list.
my $pageableInfo = ; # Pageable | PageableWsDTO
my $versionId = versionId_example; # String | The catalog version identifier
my $currentPage = currentPage_example; # String | The requested page number
my $mask = mask_example; # String | The string value on which media containers will be filtered
my $sort = sort_example; # String | The string field the results will be sorted with

eval { 
    my $result = $api_instance->getMediaContainersByText(catalogId => $catalogId, pageSize => $pageSize, pageableInfo => $pageableInfo, versionId => $versionId, currentPage => $currentPage, mask => $mask, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MediaContainersApi->getMediaContainersByText: $@\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.MediaContainersApi()
catalogId = catalogId_example # String | The catalog id
pageSize = pageSize_example # String | The maximum number of elements in the result list.
pageableInfo =  # Pageable | PageableWsDTO
versionId = versionId_example # String | The catalog version identifier
currentPage = currentPage_example # String | The requested page number (optional)
mask = mask_example # String | The string value on which media containers will be filtered (optional)
sort = sort_example # String | The string field the results will be sorted with (optional)

try: 
    # Finds media container by partial to full code matching.
    api_response = api_instance.get_media_containers_by_text(catalogId, pageSize, pageableInfo, versionId, currentPage=currentPage, mask=mask, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MediaContainersApi->getMediaContainersByText: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog id
Required
versionId*
String
The catalog version identifier
Required
Query parameters
Name Description
currentPage
String
The requested page number
mask
String
The string value on which media containers will be filtered
pageSize*
String
The maximum number of elements in the result list.
Required
pageableInfo*
Pageable
PageableWsDTO
Required
sort
String
The string field the results will be sorted with

Responses

Status: 200 - Item which serves as a wrapper object that contains a list of MediaContainerData; never null

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


MediaFolder

getMediaFoldersByText

Finds media folders by partial to full qualifier matching.

Retrieves a list of available media folders using a free text search field.


/v1/mediafolders

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/mediafolders?currentPage=&mask=&pageSize=&pageableInfo="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MediaFolderApi;

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

public class MediaFolderApiExample {

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

        MediaFolderApi apiInstance = new MediaFolderApi();
        String pageSize = pageSize_example; // String | The maximum number of elements in the result list.
        Pageable pageableInfo = ; // Pageable | PageableWsDTO
        String currentPage = currentPage_example; // String | The requested page number
        String mask = mask_example; // String | The string value on which media folders will be filtered
        try {
            MediaFolderList result = apiInstance.getMediaFoldersByText(pageSize, pageableInfo, currentPage, mask);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaFolderApi#getMediaFoldersByText");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MediaFolderApi;

public class MediaFolderApiExample {

    public static void main(String[] args) {
        MediaFolderApi apiInstance = new MediaFolderApi();
        String pageSize = pageSize_example; // String | The maximum number of elements in the result list.
        Pageable pageableInfo = ; // Pageable | PageableWsDTO
        String currentPage = currentPage_example; // String | The requested page number
        String mask = mask_example; // String | The string value on which media folders will be filtered
        try {
            MediaFolderList result = apiInstance.getMediaFoldersByText(pageSize, pageableInfo, currentPage, mask);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaFolderApi#getMediaFoldersByText");
            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 *pageSize = pageSize_example; // The maximum number of elements in the result list.
Pageable *pageableInfo = ; // PageableWsDTO
String *currentPage = currentPage_example; // The requested page number (optional)
String *mask = mask_example; // The string value on which media folders will be filtered (optional)

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

// Finds media folders by partial to full qualifier matching.
[apiInstance getMediaFoldersByTextWith:pageSize
    pageableInfo:pageableInfo
    currentPage:currentPage
    mask:mask
              completionHandler: ^(MediaFolderList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.MediaFolderApi()
var pageSize = pageSize_example; // {{String}} The maximum number of elements in the result list.
var pageableInfo = ; // {{Pageable}} PageableWsDTO
var opts = { 
  'currentPage': currentPage_example, // {{String}} The requested page number
  'mask': mask_example // {{String}} The string value on which media folders will be filtered
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMediaFoldersByText(pageSize, pageableInfo, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMediaFoldersByTextExample
    {
        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 MediaFolderApi();
            var pageSize = pageSize_example;  // String | The maximum number of elements in the result list.
            var pageableInfo = new Pageable(); // Pageable | PageableWsDTO
            var currentPage = currentPage_example;  // String | The requested page number (optional) 
            var mask = mask_example;  // String | The string value on which media folders will be filtered (optional) 

            try
            {
                // Finds media folders by partial to full qualifier matching.
                MediaFolderList result = apiInstance.getMediaFoldersByText(pageSize, pageableInfo, currentPage, mask);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MediaFolderApi.getMediaFoldersByText: " + 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\ApiMediaFolderApi();
$pageSize = pageSize_example; // String | The maximum number of elements in the result list.
$pageableInfo = ; // Pageable | PageableWsDTO
$currentPage = currentPage_example; // String | The requested page number
$mask = mask_example; // String | The string value on which media folders will be filtered

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

# 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::MediaFolderApi->new();
my $pageSize = pageSize_example; # String | The maximum number of elements in the result list.
my $pageableInfo = ; # Pageable | PageableWsDTO
my $currentPage = currentPage_example; # String | The requested page number
my $mask = mask_example; # String | The string value on which media folders will be filtered

eval { 
    my $result = $api_instance->getMediaFoldersByText(pageSize => $pageSize, pageableInfo => $pageableInfo, currentPage => $currentPage, mask => $mask);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MediaFolderApi->getMediaFoldersByText: $@\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.MediaFolderApi()
pageSize = pageSize_example # String | The maximum number of elements in the result list.
pageableInfo =  # Pageable | PageableWsDTO
currentPage = currentPage_example # String | The requested page number (optional)
mask = mask_example # String | The string value on which media folders will be filtered (optional)

try: 
    # Finds media folders by partial to full qualifier matching.
    api_response = api_instance.get_media_folders_by_text(pageSize, pageableInfo, currentPage=currentPage, mask=mask)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MediaFolderApi->getMediaFoldersByText: %s\n" % e)

Parameters

Query parameters
Name Description
currentPage
String
The requested page number
mask
String
The string value on which media folders will be filtered
pageSize*
String
The maximum number of elements in the result list.
Required
pageableInfo*
Pageable
PageableWsDTO
Required

Responses

Status: 200 - Item which serves as a wrapper object that contains a list of MediaFolderData; never null

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


Medias

getMediasByText

Finds medias by partial to full code matching.

Retrieves a list of available medias using a free text search field.


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

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/catalogs/{catalogId}/versions/{versionId}/medias?currentPage=&mask=&mimeType=&pageSize=&pageableInfo="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MediasApi;

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

public class MediasApiExample {

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

        MediasApi apiInstance = new MediasApi();
        String catalogId = catalogId_example; // String | The catalog id
        String pageSize = pageSize_example; // String | The maximum number of elements in the result list.
        Pageable pageableInfo = ; // Pageable | PageableWsDTO
        String versionId = versionId_example; // String | The catalog version identifier
        String currentPage = currentPage_example; // String | The requested page number
        String mask = mask_example; // String | The string value on which medias will be filtered
        String mimeType = mimeType_example; // String | The string value on which medias will be filtered
        try {
            MediaListData result = apiInstance.getMediasByText(catalogId, pageSize, pageableInfo, versionId, currentPage, mask, mimeType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediasApi#getMediasByText");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MediasApi;

public class MediasApiExample {

    public static void main(String[] args) {
        MediasApi apiInstance = new MediasApi();
        String catalogId = catalogId_example; // String | The catalog id
        String pageSize = pageSize_example; // String | The maximum number of elements in the result list.
        Pageable pageableInfo = ; // Pageable | PageableWsDTO
        String versionId = versionId_example; // String | The catalog version identifier
        String currentPage = currentPage_example; // String | The requested page number
        String mask = mask_example; // String | The string value on which medias will be filtered
        String mimeType = mimeType_example; // String | The string value on which medias will be filtered
        try {
            MediaListData result = apiInstance.getMediasByText(catalogId, pageSize, pageableInfo, versionId, currentPage, mask, mimeType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediasApi#getMediasByText");
            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
String *pageSize = pageSize_example; // The maximum number of elements in the result list.
Pageable *pageableInfo = ; // PageableWsDTO
String *versionId = versionId_example; // The catalog version identifier
String *currentPage = currentPage_example; // The requested page number (optional)
String *mask = mask_example; // The string value on which medias will be filtered (optional)
String *mimeType = mimeType_example; // The string value on which medias will be filtered (optional)

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

// Finds medias by partial to full code matching.
[apiInstance getMediasByTextWith:catalogId
    pageSize:pageSize
    pageableInfo:pageableInfo
    versionId:versionId
    currentPage:currentPage
    mask:mask
    mimeType:mimeType
              completionHandler: ^(MediaListData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.MediasApi()
var catalogId = catalogId_example; // {{String}} The catalog id
var pageSize = pageSize_example; // {{String}} The maximum number of elements in the result list.
var pageableInfo = ; // {{Pageable}} PageableWsDTO
var versionId = versionId_example; // {{String}} The catalog version identifier
var opts = { 
  'currentPage': currentPage_example, // {{String}} The requested page number
  'mask': mask_example, // {{String}} The string value on which medias will be filtered
  'mimeType': mimeType_example // {{String}} The string value on which medias will be filtered
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMediasByText(catalogId, 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 getMediasByTextExample
    {
        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 MediasApi();
            var catalogId = catalogId_example;  // String | The catalog id
            var pageSize = pageSize_example;  // String | The maximum number of elements in the result list.
            var pageableInfo = new Pageable(); // Pageable | PageableWsDTO
            var versionId = versionId_example;  // String | The catalog version identifier
            var currentPage = currentPage_example;  // String | The requested page number (optional) 
            var mask = mask_example;  // String | The string value on which medias will be filtered (optional) 
            var mimeType = mimeType_example;  // String | The string value on which medias will be filtered (optional) 

            try
            {
                // Finds medias by partial to full code matching.
                MediaListData result = apiInstance.getMediasByText(catalogId, pageSize, pageableInfo, versionId, currentPage, mask, mimeType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MediasApi.getMediasByText: " + 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\ApiMediasApi();
$catalogId = catalogId_example; // String | The catalog id
$pageSize = pageSize_example; // String | The maximum number of elements in the result list.
$pageableInfo = ; // Pageable | PageableWsDTO
$versionId = versionId_example; // String | The catalog version identifier
$currentPage = currentPage_example; // String | The requested page number
$mask = mask_example; // String | The string value on which medias will be filtered
$mimeType = mimeType_example; // String | The string value on which medias will be filtered

try {
    $result = $api_instance->getMediasByText($catalogId, $pageSize, $pageableInfo, $versionId, $currentPage, $mask, $mimeType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MediasApi->getMediasByText: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MediasApi;

# 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::MediasApi->new();
my $catalogId = catalogId_example; # String | The catalog id
my $pageSize = pageSize_example; # String | The maximum number of elements in the result list.
my $pageableInfo = ; # Pageable | PageableWsDTO
my $versionId = versionId_example; # String | The catalog version identifier
my $currentPage = currentPage_example; # String | The requested page number
my $mask = mask_example; # String | The string value on which medias will be filtered
my $mimeType = mimeType_example; # String | The string value on which medias will be filtered

eval { 
    my $result = $api_instance->getMediasByText(catalogId => $catalogId, pageSize => $pageSize, pageableInfo => $pageableInfo, versionId => $versionId, currentPage => $currentPage, mask => $mask, mimeType => $mimeType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MediasApi->getMediasByText: $@\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.MediasApi()
catalogId = catalogId_example # String | The catalog id
pageSize = pageSize_example # String | The maximum number of elements in the result list.
pageableInfo =  # Pageable | PageableWsDTO
versionId = versionId_example # String | The catalog version identifier
currentPage = currentPage_example # String | The requested page number (optional)
mask = mask_example # String | The string value on which medias will be filtered (optional)
mimeType = mimeType_example # String | The string value on which medias will be filtered (optional)

try: 
    # Finds medias by partial to full code matching.
    api_response = api_instance.get_medias_by_text(catalogId, pageSize, pageableInfo, versionId, currentPage=currentPage, mask=mask, mimeType=mimeType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MediasApi->getMediasByText: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog id
Required
versionId*
String
The catalog version identifier
Required
Query parameters
Name Description
currentPage
String
The requested page number
mask
String
The string value on which medias will be filtered
mimeType
String
The string value on which medias will be filtered
pageSize*
String
The maximum number of elements in the result list.
Required
pageableInfo*
Pageable
PageableWsDTO
Required

Responses

Status: 200 - Item which serves as a wrapper object that contains a list of MediaData; never null

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


Navigation

createNavigationNodeById

Creates navigation node.

Adds a new navigation node for a given catalog id.


/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/navigations

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/cmswebservices/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/navigations"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NavigationApi;

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

public class NavigationApiExample {

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

        NavigationApi apiInstance = new NavigationApi();
        NavigationNodeData body = ; // NavigationNodeData | 
        String catalogId = catalogId_example; // String | The catalog name
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            NavigationNodeData result = apiInstance.createNavigationNodeById(body, catalogId, siteId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NavigationApi#createNavigationNodeById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NavigationApi;

public class NavigationApiExample {

    public static void main(String[] args) {
        NavigationApi apiInstance = new NavigationApi();
        NavigationNodeData body = ; // NavigationNodeData | 
        String catalogId = catalogId_example; // String | The catalog name
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            NavigationNodeData result = apiInstance.createNavigationNodeById(body, catalogId, siteId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NavigationApi#createNavigationNodeById");
            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"];
NavigationNodeData *body = ; // 
String *catalogId = catalogId_example; // The catalog name
String *siteId = siteId_example; // The site identifier
String *versionId = versionId_example; // The catalog version identifier

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

// Creates navigation node.
[apiInstance createNavigationNodeByIdWith:body
    catalogId:catalogId
    siteId:siteId
    versionId:versionId
              completionHandler: ^(NavigationNodeData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.NavigationApi()
var body = ; // {{NavigationNodeData}} 
var catalogId = catalogId_example; // {{String}} The catalog name
var siteId = siteId_example; // {{String}} The site identifier
var versionId = versionId_example; // {{String}} The catalog version identifier

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

namespace Example
{
    public class createNavigationNodeByIdExample
    {
        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 NavigationApi();
            var body = new NavigationNodeData(); // NavigationNodeData | 
            var catalogId = catalogId_example;  // String | The catalog name
            var siteId = siteId_example;  // String | The site identifier
            var versionId = versionId_example;  // String | The catalog version identifier

            try
            {
                // Creates navigation node.
                NavigationNodeData result = apiInstance.createNavigationNodeById(body, catalogId, siteId, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NavigationApi.createNavigationNodeById: " + 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\ApiNavigationApi();
$body = ; // NavigationNodeData | 
$catalogId = catalogId_example; // String | The catalog name
$siteId = siteId_example; // String | The site identifier
$versionId = versionId_example; // String | The catalog version identifier

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

# 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::NavigationApi->new();
my $body = WWW::SwaggerClient::Object::NavigationNodeData->new(); # NavigationNodeData | 
my $catalogId = catalogId_example; # String | The catalog name
my $siteId = siteId_example; # String | The site identifier
my $versionId = versionId_example; # String | The catalog version identifier

eval { 
    my $result = $api_instance->createNavigationNodeById(body => $body, catalogId => $catalogId, siteId => $siteId, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NavigationApi->createNavigationNodeById: $@\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.NavigationApi()
body =  # NavigationNodeData | 
catalogId = catalogId_example # String | The catalog name
siteId = siteId_example # String | The site identifier
versionId = versionId_example # String | The catalog version identifier

try: 
    # Creates navigation node.
    api_response = api_instance.create_navigation_node_by_id(body, catalogId, siteId, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NavigationApi->createNavigationNodeById: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog name
Required
siteId*
String
The site identifier
Required
versionId*
String
The catalog version identifier
Required
Body parameters
Name Description
body *

Responses

Status: 200 - The navigation node data created.

Status: 400 - If the parentUid does not exist (CMSItemNotFoundException) or if there is any validation error (WebserviceValidationException)

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getNavigationAncestorsAndSelf1

Finds all navigation ancestors and self.

Finds all navigation ancestors for a given node uid and the node itself.


/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/navigations

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/navigations?ancestorTrailFrom=&parentUid="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NavigationApi;

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

public class NavigationApiExample {

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

        NavigationApi apiInstance = new NavigationApi();
        String ancestorTrailFrom = ancestorTrailFrom_example; // String | The navigation node's Uid whose ancestors are to be extracted.
        String catalogId = catalogId_example; // String | The catalog name
        String parentUid = parentUid_example; // String | The parent navigation node Uid
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            NavigationNodeListData result = apiInstance.getNavigationAncestorsAndSelf1(ancestorTrailFrom, catalogId, parentUid, siteId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NavigationApi#getNavigationAncestorsAndSelf1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NavigationApi;

public class NavigationApiExample {

    public static void main(String[] args) {
        NavigationApi apiInstance = new NavigationApi();
        String ancestorTrailFrom = ancestorTrailFrom_example; // String | The navigation node's Uid whose ancestors are to be extracted.
        String catalogId = catalogId_example; // String | The catalog name
        String parentUid = parentUid_example; // String | The parent navigation node Uid
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            NavigationNodeListData result = apiInstance.getNavigationAncestorsAndSelf1(ancestorTrailFrom, catalogId, parentUid, siteId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NavigationApi#getNavigationAncestorsAndSelf1");
            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 *ancestorTrailFrom = ancestorTrailFrom_example; // The navigation node's Uid whose ancestors are to be extracted.
String *catalogId = catalogId_example; // The catalog name
String *parentUid = parentUid_example; // The parent navigation node Uid
String *siteId = siteId_example; // The site identifier
String *versionId = versionId_example; // The catalog version identifier

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

// Finds all navigation ancestors and self.
[apiInstance getNavigationAncestorsAndSelf1With:ancestorTrailFrom
    catalogId:catalogId
    parentUid:parentUid
    siteId:siteId
    versionId:versionId
              completionHandler: ^(NavigationNodeListData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.NavigationApi()
var ancestorTrailFrom = ancestorTrailFrom_example; // {{String}} The navigation node's Uid whose ancestors are to be extracted.
var catalogId = catalogId_example; // {{String}} The catalog name
var parentUid = parentUid_example; // {{String}} The parent navigation node Uid
var siteId = siteId_example; // {{String}} The site identifier
var versionId = versionId_example; // {{String}} The catalog version identifier

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

namespace Example
{
    public class getNavigationAncestorsAndSelf1Example
    {
        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 NavigationApi();
            var ancestorTrailFrom = ancestorTrailFrom_example;  // String | The navigation node's Uid whose ancestors are to be extracted.
            var catalogId = catalogId_example;  // String | The catalog name
            var parentUid = parentUid_example;  // String | The parent navigation node Uid
            var siteId = siteId_example;  // String | The site identifier
            var versionId = versionId_example;  // String | The catalog version identifier

            try
            {
                // Finds all navigation ancestors and self.
                NavigationNodeListData result = apiInstance.getNavigationAncestorsAndSelf1(ancestorTrailFrom, catalogId, parentUid, siteId, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NavigationApi.getNavigationAncestorsAndSelf1: " + 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\ApiNavigationApi();
$ancestorTrailFrom = ancestorTrailFrom_example; // String | The navigation node's Uid whose ancestors are to be extracted.
$catalogId = catalogId_example; // String | The catalog name
$parentUid = parentUid_example; // String | The parent navigation node Uid
$siteId = siteId_example; // String | The site identifier
$versionId = versionId_example; // String | The catalog version identifier

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

# 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::NavigationApi->new();
my $ancestorTrailFrom = ancestorTrailFrom_example; # String | The navigation node's Uid whose ancestors are to be extracted.
my $catalogId = catalogId_example; # String | The catalog name
my $parentUid = parentUid_example; # String | The parent navigation node Uid
my $siteId = siteId_example; # String | The site identifier
my $versionId = versionId_example; # String | The catalog version identifier

eval { 
    my $result = $api_instance->getNavigationAncestorsAndSelf1(ancestorTrailFrom => $ancestorTrailFrom, catalogId => $catalogId, parentUid => $parentUid, siteId => $siteId, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NavigationApi->getNavigationAncestorsAndSelf1: $@\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.NavigationApi()
ancestorTrailFrom = ancestorTrailFrom_example # String | The navigation node's Uid whose ancestors are to be extracted.
catalogId = catalogId_example # String | The catalog name
parentUid = parentUid_example # String | The parent navigation node Uid
siteId = siteId_example # String | The site identifier
versionId = versionId_example # String | The catalog version identifier

try: 
    # Finds all navigation ancestors and self.
    api_response = api_instance.get_navigation_ancestors_and_self1(ancestorTrailFrom, catalogId, parentUid, siteId, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NavigationApi->getNavigationAncestorsAndSelf1: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog name
Required
siteId*
String
The site identifier
Required
versionId*
String
The catalog version identifier
Required
Query parameters
Name Description
ancestorTrailFrom*
String
The navigation node's Uid whose ancestors are to be extracted.
Required
parentUid*
String
The parent navigation node Uid
Required

Responses

Status: 200 - The navigation node's ancestors and the node itself.

Status: 400 - When the navigation node uid does not exist (CMSItemNotFoundException).

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getNavigationNodeById

Finds navigation node.

Retrieves a specific navigation node item. Information is retrieved based on a given site and catalog ids.


/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/navigations/{uid}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/navigations/{uid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NavigationApi;

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

public class NavigationApiExample {

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

        NavigationApi apiInstance = new NavigationApi();
        String catalogId = catalogId_example; // String | The catalog name
        String siteId = siteId_example; // String | The site identifier
        String uid = uid_example; // String | The navigation node's unique identifier
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            NavigationNodeData result = apiInstance.getNavigationNodeById(catalogId, siteId, uid, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NavigationApi#getNavigationNodeById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NavigationApi;

public class NavigationApiExample {

    public static void main(String[] args) {
        NavigationApi apiInstance = new NavigationApi();
        String catalogId = catalogId_example; // String | The catalog name
        String siteId = siteId_example; // String | The site identifier
        String uid = uid_example; // String | The navigation node's unique identifier
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            NavigationNodeData result = apiInstance.getNavigationNodeById(catalogId, siteId, uid, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NavigationApi#getNavigationNodeById");
            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 name
String *siteId = siteId_example; // The site identifier
String *uid = uid_example; // The navigation node's unique identifier
String *versionId = versionId_example; // The catalog version identifier

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

// Finds navigation node.
[apiInstance getNavigationNodeByIdWith:catalogId
    siteId:siteId
    uid:uid
    versionId:versionId
              completionHandler: ^(NavigationNodeData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.NavigationApi()
var catalogId = catalogId_example; // {{String}} The catalog name
var siteId = siteId_example; // {{String}} The site identifier
var uid = uid_example; // {{String}} The navigation node's unique identifier
var versionId = versionId_example; // {{String}} The catalog version identifier

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

namespace Example
{
    public class getNavigationNodeByIdExample
    {
        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 NavigationApi();
            var catalogId = catalogId_example;  // String | The catalog name
            var siteId = siteId_example;  // String | The site identifier
            var uid = uid_example;  // String | The navigation node's unique identifier
            var versionId = versionId_example;  // String | The catalog version identifier

            try
            {
                // Finds navigation node.
                NavigationNodeData result = apiInstance.getNavigationNodeById(catalogId, siteId, uid, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NavigationApi.getNavigationNodeById: " + 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\ApiNavigationApi();
$catalogId = catalogId_example; // String | The catalog name
$siteId = siteId_example; // String | The site identifier
$uid = uid_example; // String | The navigation node's unique identifier
$versionId = versionId_example; // String | The catalog version identifier

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

# 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::NavigationApi->new();
my $catalogId = catalogId_example; # String | The catalog name
my $siteId = siteId_example; # String | The site identifier
my $uid = uid_example; # String | The navigation node's unique identifier
my $versionId = versionId_example; # String | The catalog version identifier

eval { 
    my $result = $api_instance->getNavigationNodeById(catalogId => $catalogId, siteId => $siteId, uid => $uid, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NavigationApi->getNavigationNodeById: $@\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.NavigationApi()
catalogId = catalogId_example # String | The catalog name
siteId = siteId_example # String | The site identifier
uid = uid_example # String | The navigation node's unique identifier
versionId = versionId_example # String | The catalog version identifier

try: 
    # Finds navigation node.
    api_response = api_instance.get_navigation_node_by_id(catalogId, siteId, uid, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NavigationApi->getNavigationNodeById: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog name
Required
siteId*
String
The site identifier
Required
uid*
String
The navigation node's unique identifier
Required
versionId*
String
The catalog version identifier
Required

Responses

Status: 200 - The navigation node identified by uid.

Status: 400 - When the Navigation Node has not been found (CMSItemNotFoundException).

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


removeNavigationNodeById

Deletes navigation node.

Removes a specific instance of the navigation node that matches a given site id. Deprecated since 1811, please use DELETE /v1/sites/{siteId}/cmsitems/{uuid} instead.


/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/navigations/{uid}

Usage and SDK Samples

curl -X DELETE\
\
\
"http://localhost:9001/cmswebservices/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/navigations/{uid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NavigationApi;

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

public class NavigationApiExample {

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

        NavigationApi apiInstance = new NavigationApi();
        String catalogId = catalogId_example; // String | The catalog name
        String siteId = siteId_example; // String | The site identifier
        String uid = uid_example; // String | The navigation node's uid.
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            apiInstance.removeNavigationNodeById(catalogId, siteId, uid, versionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling NavigationApi#removeNavigationNodeById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NavigationApi;

public class NavigationApiExample {

    public static void main(String[] args) {
        NavigationApi apiInstance = new NavigationApi();
        String catalogId = catalogId_example; // String | The catalog name
        String siteId = siteId_example; // String | The site identifier
        String uid = uid_example; // String | The navigation node's uid.
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            apiInstance.removeNavigationNodeById(catalogId, siteId, uid, versionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling NavigationApi#removeNavigationNodeById");
            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 name
String *siteId = siteId_example; // The site identifier
String *uid = uid_example; // The navigation node's uid.
String *versionId = versionId_example; // The catalog version identifier

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

// Deletes navigation node.
[apiInstance removeNavigationNodeByIdWith:catalogId
    siteId:siteId
    uid:uid
    versionId:versionId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.NavigationApi()
var catalogId = catalogId_example; // {{String}} The catalog name
var siteId = siteId_example; // {{String}} The site identifier
var uid = uid_example; // {{String}} The navigation node's uid.
var versionId = versionId_example; // {{String}} The catalog version identifier

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

namespace Example
{
    public class removeNavigationNodeByIdExample
    {
        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 NavigationApi();
            var catalogId = catalogId_example;  // String | The catalog name
            var siteId = siteId_example;  // String | The site identifier
            var uid = uid_example;  // String | The navigation node's uid.
            var versionId = versionId_example;  // String | The catalog version identifier

            try
            {
                // Deletes navigation node.
                apiInstance.removeNavigationNodeById(catalogId, siteId, uid, versionId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NavigationApi.removeNavigationNodeById: " + 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\ApiNavigationApi();
$catalogId = catalogId_example; // String | The catalog name
$siteId = siteId_example; // String | The site identifier
$uid = uid_example; // String | The navigation node's uid.
$versionId = versionId_example; // String | The catalog version identifier

try {
    $api_instance->removeNavigationNodeById($catalogId, $siteId, $uid, $versionId);
} catch (Exception $e) {
    echo 'Exception when calling NavigationApi->removeNavigationNodeById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NavigationApi;

# 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::NavigationApi->new();
my $catalogId = catalogId_example; # String | The catalog name
my $siteId = siteId_example; # String | The site identifier
my $uid = uid_example; # String | The navigation node's uid.
my $versionId = versionId_example; # String | The catalog version identifier

eval { 
    $api_instance->removeNavigationNodeById(catalogId => $catalogId, siteId => $siteId, uid => $uid, versionId => $versionId);
};
if ($@) {
    warn "Exception when calling NavigationApi->removeNavigationNodeById: $@\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.NavigationApi()
catalogId = catalogId_example # String | The catalog name
siteId = siteId_example # String | The site identifier
uid = uid_example # String | The navigation node's uid.
versionId = versionId_example # String | The catalog version identifier

try: 
    # Deletes navigation node.
    api_instance.remove_navigation_node_by_id(catalogId, siteId, uid, versionId)
except ApiException as e:
    print("Exception when calling NavigationApi->removeNavigationNodeById: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog name
Required
siteId*
String
The site identifier
Required
uid*
String
The navigation node's uid.
Required
versionId*
String
The catalog version identifier
Required

Responses

Status: 400 - When the Navigation Node has not been found (CMSItemNotFoundException).

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


replaceNavigationNodeById

Updates navigation node.

Provides new information to the navigation node for a given.navigation node uid. Deprecated since 1811, please use CMSItemController controller instead.


/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/navigations/{uid}

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/cmswebservices/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/navigations/{uid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NavigationApi;

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

public class NavigationApiExample {

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

        NavigationApi apiInstance = new NavigationApi();
        NavigationNodeData body = ; // NavigationNodeData | 
        String catalogId = catalogId_example; // String | The catalog name
        String siteId = siteId_example; // String | The site identifier
        String uid = uid_example; // String | The navigation node uid to be updated.
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            apiInstance.replaceNavigationNodeById(body, catalogId, siteId, uid, versionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling NavigationApi#replaceNavigationNodeById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NavigationApi;

public class NavigationApiExample {

    public static void main(String[] args) {
        NavigationApi apiInstance = new NavigationApi();
        NavigationNodeData body = ; // NavigationNodeData | 
        String catalogId = catalogId_example; // String | The catalog name
        String siteId = siteId_example; // String | The site identifier
        String uid = uid_example; // String | The navigation node uid to be updated.
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            apiInstance.replaceNavigationNodeById(body, catalogId, siteId, uid, versionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling NavigationApi#replaceNavigationNodeById");
            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"];
NavigationNodeData *body = ; // 
String *catalogId = catalogId_example; // The catalog name
String *siteId = siteId_example; // The site identifier
String *uid = uid_example; // The navigation node uid to be updated.
String *versionId = versionId_example; // The catalog version identifier

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

// Updates navigation node.
[apiInstance replaceNavigationNodeByIdWith:body
    catalogId:catalogId
    siteId:siteId
    uid:uid
    versionId:versionId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.NavigationApi()
var body = ; // {{NavigationNodeData}} 
var catalogId = catalogId_example; // {{String}} The catalog name
var siteId = siteId_example; // {{String}} The site identifier
var uid = uid_example; // {{String}} The navigation node uid to be updated.
var versionId = versionId_example; // {{String}} The catalog version identifier

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

namespace Example
{
    public class replaceNavigationNodeByIdExample
    {
        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 NavigationApi();
            var body = new NavigationNodeData(); // NavigationNodeData | 
            var catalogId = catalogId_example;  // String | The catalog name
            var siteId = siteId_example;  // String | The site identifier
            var uid = uid_example;  // String | The navigation node uid to be updated.
            var versionId = versionId_example;  // String | The catalog version identifier

            try
            {
                // Updates navigation node.
                apiInstance.replaceNavigationNodeById(body, catalogId, siteId, uid, versionId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NavigationApi.replaceNavigationNodeById: " + 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\ApiNavigationApi();
$body = ; // NavigationNodeData | 
$catalogId = catalogId_example; // String | The catalog name
$siteId = siteId_example; // String | The site identifier
$uid = uid_example; // String | The navigation node uid to be updated.
$versionId = versionId_example; // String | The catalog version identifier

try {
    $api_instance->replaceNavigationNodeById($body, $catalogId, $siteId, $uid, $versionId);
} catch (Exception $e) {
    echo 'Exception when calling NavigationApi->replaceNavigationNodeById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NavigationApi;

# 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::NavigationApi->new();
my $body = WWW::SwaggerClient::Object::NavigationNodeData->new(); # NavigationNodeData | 
my $catalogId = catalogId_example; # String | The catalog name
my $siteId = siteId_example; # String | The site identifier
my $uid = uid_example; # String | The navigation node uid to be updated.
my $versionId = versionId_example; # String | The catalog version identifier

eval { 
    $api_instance->replaceNavigationNodeById(body => $body, catalogId => $catalogId, siteId => $siteId, uid => $uid, versionId => $versionId);
};
if ($@) {
    warn "Exception when calling NavigationApi->replaceNavigationNodeById: $@\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.NavigationApi()
body =  # NavigationNodeData | 
catalogId = catalogId_example # String | The catalog name
siteId = siteId_example # String | The site identifier
uid = uid_example # String | The navigation node uid to be updated.
versionId = versionId_example # String | The catalog version identifier

try: 
    # Updates navigation node.
    api_instance.replace_navigation_node_by_id(body, catalogId, siteId, uid, versionId)
except ApiException as e:
    print("Exception when calling NavigationApi->replaceNavigationNodeById: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog name
Required
siteId*
String
The site identifier
Required
uid*
String
The navigation node uid to be updated.
Required
versionId*
String
The catalog version identifier
Required
Body parameters
Name Description
body *

Responses

Status: 400 - When the Navigation Node has not been found (CMSItemNotFoundException) or if there is any validation error (WebserviceValidationException).

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


PageRestrictions

getRestrictionsByPage1

Gets restrictions by page.

Retrieves all restrictions that belong to the page for the given page id.


/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagesrestrictions

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagesrestrictions?pageId=&pageIds="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PageRestrictionsApi;

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

public class PageRestrictionsApiExample {

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

        PageRestrictionsApi apiInstance = new PageRestrictionsApi();
        String catalogId = catalogId_example; // String | The catalog name
        String pageId = pageId_example; // String | Identifier of the page
        array[String] pageIds = ; // array[String] | The list of page identifiers
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            PageRestrictionListData result = apiInstance.getRestrictionsByPage1(catalogId, pageId, pageIds, siteId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageRestrictionsApi#getRestrictionsByPage1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PageRestrictionsApi;

public class PageRestrictionsApiExample {

    public static void main(String[] args) {
        PageRestrictionsApi apiInstance = new PageRestrictionsApi();
        String catalogId = catalogId_example; // String | The catalog name
        String pageId = pageId_example; // String | Identifier of the page
        array[String] pageIds = ; // array[String] | The list of page identifiers
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            PageRestrictionListData result = apiInstance.getRestrictionsByPage1(catalogId, pageId, pageIds, siteId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageRestrictionsApi#getRestrictionsByPage1");
            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 name
String *pageId = pageId_example; // Identifier of the page
array[String] *pageIds = ; // The list of page identifiers
String *siteId = siteId_example; // The site identifier
String *versionId = versionId_example; // The catalog version identifier

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

// Gets restrictions by page.
[apiInstance getRestrictionsByPage1With:catalogId
    pageId:pageId
    pageIds:pageIds
    siteId:siteId
    versionId:versionId
              completionHandler: ^(PageRestrictionListData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.PageRestrictionsApi()
var catalogId = catalogId_example; // {{String}} The catalog name
var pageId = pageId_example; // {{String}} Identifier of the page
var pageIds = ; // {{array[String]}} The list of page identifiers
var siteId = siteId_example; // {{String}} The site identifier
var versionId = versionId_example; // {{String}} The catalog version identifier

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

namespace Example
{
    public class getRestrictionsByPage1Example
    {
        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 PageRestrictionsApi();
            var catalogId = catalogId_example;  // String | The catalog name
            var pageId = pageId_example;  // String | Identifier of the page
            var pageIds = new array[String](); // array[String] | The list of page identifiers
            var siteId = siteId_example;  // String | The site identifier
            var versionId = versionId_example;  // String | The catalog version identifier

            try
            {
                // Gets restrictions by page.
                PageRestrictionListData result = apiInstance.getRestrictionsByPage1(catalogId, pageId, pageIds, siteId, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PageRestrictionsApi.getRestrictionsByPage1: " + 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\ApiPageRestrictionsApi();
$catalogId = catalogId_example; // String | The catalog name
$pageId = pageId_example; // String | Identifier of the page
$pageIds = ; // array[String] | The list of page identifiers
$siteId = siteId_example; // String | The site identifier
$versionId = versionId_example; // String | The catalog version identifier

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

# 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::PageRestrictionsApi->new();
my $catalogId = catalogId_example; # String | The catalog name
my $pageId = pageId_example; # String | Identifier of the page
my $pageIds = []; # array[String] | The list of page identifiers
my $siteId = siteId_example; # String | The site identifier
my $versionId = versionId_example; # String | The catalog version identifier

eval { 
    my $result = $api_instance->getRestrictionsByPage1(catalogId => $catalogId, pageId => $pageId, pageIds => $pageIds, siteId => $siteId, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PageRestrictionsApi->getRestrictionsByPage1: $@\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.PageRestrictionsApi()
catalogId = catalogId_example # String | The catalog name
pageId = pageId_example # String | Identifier of the page
pageIds =  # array[String] | The list of page identifiers
siteId = siteId_example # String | The site identifier
versionId = versionId_example # String | The catalog version identifier

try: 
    # Gets restrictions by page.
    api_response = api_instance.get_restrictions_by_page1(catalogId, pageId, pageIds, siteId, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PageRestrictionsApi->getRestrictionsByPage1: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog name
Required
siteId*
String
The site identifier
Required
versionId*
String
The catalog version identifier
Required
Query parameters
Name Description
pageId*
String
Identifier of the page
Required
pageIds*
array[String]
The list of page identifiers
Required

Responses

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

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


replacePageRestrictionListData

Updates page restrictions.

Replaces an existing list of page-restriction relations with a new relations for the given page id.


/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagesrestrictions/pages/{pageId}

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/cmswebservices/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagesrestrictions/pages/{pageId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PageRestrictionsApi;

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

public class PageRestrictionsApiExample {

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

        PageRestrictionsApi apiInstance = new PageRestrictionsApi();
        PageRestrictionListData body = ; // PageRestrictionListData | 
        String catalogId = catalogId_example; // String | The catalog name
        String pageId = pageId_example; // String | Page identifier
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            PageRestrictionListData result = apiInstance.replacePageRestrictionListData(body, catalogId, pageId, siteId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageRestrictionsApi#replacePageRestrictionListData");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PageRestrictionsApi;

public class PageRestrictionsApiExample {

    public static void main(String[] args) {
        PageRestrictionsApi apiInstance = new PageRestrictionsApi();
        PageRestrictionListData body = ; // PageRestrictionListData | 
        String catalogId = catalogId_example; // String | The catalog name
        String pageId = pageId_example; // String | Page identifier
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            PageRestrictionListData result = apiInstance.replacePageRestrictionListData(body, catalogId, pageId, siteId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageRestrictionsApi#replacePageRestrictionListData");
            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"];
PageRestrictionListData *body = ; // 
String *catalogId = catalogId_example; // The catalog name
String *pageId = pageId_example; // Page identifier
String *siteId = siteId_example; // The site identifier
String *versionId = versionId_example; // The catalog version identifier

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

// Updates page restrictions.
[apiInstance replacePageRestrictionListDataWith:body
    catalogId:catalogId
    pageId:pageId
    siteId:siteId
    versionId:versionId
              completionHandler: ^(PageRestrictionListData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.PageRestrictionsApi()
var body = ; // {{PageRestrictionListData}} 
var catalogId = catalogId_example; // {{String}} The catalog name
var pageId = pageId_example; // {{String}} Page identifier
var siteId = siteId_example; // {{String}} The site identifier
var versionId = versionId_example; // {{String}} The catalog version identifier

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

namespace Example
{
    public class replacePageRestrictionListDataExample
    {
        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 PageRestrictionsApi();
            var body = new PageRestrictionListData(); // PageRestrictionListData | 
            var catalogId = catalogId_example;  // String | The catalog name
            var pageId = pageId_example;  // String | Page identifier
            var siteId = siteId_example;  // String | The site identifier
            var versionId = versionId_example;  // String | The catalog version identifier

            try
            {
                // Updates page restrictions.
                PageRestrictionListData result = apiInstance.replacePageRestrictionListData(body, catalogId, pageId, siteId, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PageRestrictionsApi.replacePageRestrictionListData: " + 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\ApiPageRestrictionsApi();
$body = ; // PageRestrictionListData | 
$catalogId = catalogId_example; // String | The catalog name
$pageId = pageId_example; // String | Page identifier
$siteId = siteId_example; // String | The site identifier
$versionId = versionId_example; // String | The catalog version identifier

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

# 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::PageRestrictionsApi->new();
my $body = WWW::SwaggerClient::Object::PageRestrictionListData->new(); # PageRestrictionListData | 
my $catalogId = catalogId_example; # String | The catalog name
my $pageId = pageId_example; # String | Page identifier
my $siteId = siteId_example; # String | The site identifier
my $versionId = versionId_example; # String | The catalog version identifier

eval { 
    my $result = $api_instance->replacePageRestrictionListData(body => $body, catalogId => $catalogId, pageId => $pageId, siteId => $siteId, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PageRestrictionsApi->replacePageRestrictionListData: $@\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.PageRestrictionsApi()
body =  # PageRestrictionListData | 
catalogId = catalogId_example # String | The catalog name
pageId = pageId_example # String | Page identifier
siteId = siteId_example # String | The site identifier
versionId = versionId_example # String | The catalog version identifier

try: 
    # Updates page restrictions.
    api_response = api_instance.replace_page_restriction_list_data(body, catalogId, pageId, siteId, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PageRestrictionsApi->replacePageRestrictionListData: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog name
Required
pageId*
String
Page identifier
Required
siteId*
String
The site identifier
Required
versionId*
String
The catalog version identifier
Required
Body parameters
Name Description
body *

Responses

Status: 200 - DTO which serves as a wrapper object that contains the updated list of PageRestrictionListData, never null.

Status: 400 - If it cannot find the component (CMSItemNotFoundException) or if there is any validation error (WebserviceValidationException).

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


PageSlotComponents

doAddComponentToSlot

Adds component to slot.

Inserts a new content component item to a slot for a given catalog and site ids.


/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagescontentslotscomponents

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/cmswebservices/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagescontentslotscomponents"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PageSlotComponentsApi;

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

public class PageSlotComponentsApiExample {

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

        PageSlotComponentsApi apiInstance = new PageSlotComponentsApi();
        PageContentSlotComponentData body = ; // PageContentSlotComponentData | 
        String catalogId = catalogId_example; // String | The catalog id
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            PageContentSlotComponentData result = apiInstance.doAddComponentToSlot(body, catalogId, siteId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageSlotComponentsApi#doAddComponentToSlot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PageSlotComponentsApi;

public class PageSlotComponentsApiExample {

    public static void main(String[] args) {
        PageSlotComponentsApi apiInstance = new PageSlotComponentsApi();
        PageContentSlotComponentData body = ; // PageContentSlotComponentData | 
        String catalogId = catalogId_example; // String | The catalog id
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            PageContentSlotComponentData result = apiInstance.doAddComponentToSlot(body, catalogId, siteId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageSlotComponentsApi#doAddComponentToSlot");
            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"];
PageContentSlotComponentData *body = ; // 
String *catalogId = catalogId_example; // The catalog id
String *siteId = siteId_example; // The site identifier
String *versionId = versionId_example; // The catalog version identifier

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

// Adds component to slot.
[apiInstance doAddComponentToSlotWith:body
    catalogId:catalogId
    siteId:siteId
    versionId:versionId
              completionHandler: ^(PageContentSlotComponentData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.PageSlotComponentsApi()
var body = ; // {{PageContentSlotComponentData}} 
var catalogId = catalogId_example; // {{String}} The catalog id
var siteId = siteId_example; // {{String}} The site identifier
var versionId = versionId_example; // {{String}} The catalog version identifier

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

namespace Example
{
    public class doAddComponentToSlotExample
    {
        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 PageSlotComponentsApi();
            var body = new PageContentSlotComponentData(); // PageContentSlotComponentData | 
            var catalogId = catalogId_example;  // String | The catalog id
            var siteId = siteId_example;  // String | The site identifier
            var versionId = versionId_example;  // String | The catalog version identifier

            try
            {
                // Adds component to slot.
                PageContentSlotComponentData result = apiInstance.doAddComponentToSlot(body, catalogId, siteId, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PageSlotComponentsApi.doAddComponentToSlot: " + 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\ApiPageSlotComponentsApi();
$body = ; // PageContentSlotComponentData | 
$catalogId = catalogId_example; // String | The catalog id
$siteId = siteId_example; // String | The site identifier
$versionId = versionId_example; // String | The catalog version identifier

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

# 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::PageSlotComponentsApi->new();
my $body = WWW::SwaggerClient::Object::PageContentSlotComponentData->new(); # PageContentSlotComponentData | 
my $catalogId = catalogId_example; # String | The catalog id
my $siteId = siteId_example; # String | The site identifier
my $versionId = versionId_example; # String | The catalog version identifier

eval { 
    my $result = $api_instance->doAddComponentToSlot(body => $body, catalogId => $catalogId, siteId => $siteId, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PageSlotComponentsApi->doAddComponentToSlot: $@\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.PageSlotComponentsApi()
body =  # PageContentSlotComponentData | 
catalogId = catalogId_example # String | The catalog id
siteId = siteId_example # String | The site identifier
versionId = versionId_example # String | The catalog version identifier

try: 
    # Adds component to slot.
    api_response = api_instance.do_add_component_to_slot(body, catalogId, siteId, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PageSlotComponentsApi->doAddComponentToSlot: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog id
Required
siteId*
String
The site identifier
Required
versionId*
String
The catalog version identifier
Required
Body parameters
Name Description
body *

Responses

Status: 200 - PageContentSlotComponentData

Status: 400 - When component item does not exist (CMSItemNotFoundException) or when validation errors are found (WebserviceValidationException).

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getComponentByPage

Gets components by page.

Retrieves a list of available components for a given page.


/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagescontentslotscomponents

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagescontentslotscomponents?pageId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PageSlotComponentsApi;

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

public class PageSlotComponentsApiExample {

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

        PageSlotComponentsApi apiInstance = new PageSlotComponentsApi();
        String catalogId = catalogId_example; // String | The catalog id
        String pageId = pageId_example; // String | Identifier of the page
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            PageContentSlotComponentListData result = apiInstance.getComponentByPage(catalogId, pageId, siteId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageSlotComponentsApi#getComponentByPage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PageSlotComponentsApi;

public class PageSlotComponentsApiExample {

    public static void main(String[] args) {
        PageSlotComponentsApi apiInstance = new PageSlotComponentsApi();
        String catalogId = catalogId_example; // String | The catalog id
        String pageId = pageId_example; // String | Identifier of the page
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            PageContentSlotComponentListData result = apiInstance.getComponentByPage(catalogId, pageId, siteId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageSlotComponentsApi#getComponentByPage");
            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
String *pageId = pageId_example; // Identifier of the page
String *siteId = siteId_example; // The site identifier
String *versionId = versionId_example; // The catalog version identifier

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

// Gets components by page.
[apiInstance getComponentByPageWith:catalogId
    pageId:pageId
    siteId:siteId
    versionId:versionId
              completionHandler: ^(PageContentSlotComponentListData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.PageSlotComponentsApi()
var catalogId = catalogId_example; // {{String}} The catalog id
var pageId = pageId_example; // {{String}} Identifier of the page
var siteId = siteId_example; // {{String}} The site identifier
var versionId = versionId_example; // {{String}} The catalog version identifier

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

namespace Example
{
    public class getComponentByPageExample
    {
        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 PageSlotComponentsApi();
            var catalogId = catalogId_example;  // String | The catalog id
            var pageId = pageId_example;  // String | Identifier of the page
            var siteId = siteId_example;  // String | The site identifier
            var versionId = versionId_example;  // String | The catalog version identifier

            try
            {
                // Gets components by page.
                PageContentSlotComponentListData result = apiInstance.getComponentByPage(catalogId, pageId, siteId, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PageSlotComponentsApi.getComponentByPage: " + 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\ApiPageSlotComponentsApi();
$catalogId = catalogId_example; // String | The catalog id
$pageId = pageId_example; // String | Identifier of the page
$siteId = siteId_example; // String | The site identifier
$versionId = versionId_example; // String | The catalog version identifier

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

# 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::PageSlotComponentsApi->new();
my $catalogId = catalogId_example; # String | The catalog id
my $pageId = pageId_example; # String | Identifier of the page
my $siteId = siteId_example; # String | The site identifier
my $versionId = versionId_example; # String | The catalog version identifier

eval { 
    my $result = $api_instance->getComponentByPage(catalogId => $catalogId, pageId => $pageId, siteId => $siteId, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PageSlotComponentsApi->getComponentByPage: $@\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.PageSlotComponentsApi()
catalogId = catalogId_example # String | The catalog id
pageId = pageId_example # String | Identifier of the page
siteId = siteId_example # String | The site identifier
versionId = versionId_example # String | The catalog version identifier

try: 
    # Gets components by page.
    api_response = api_instance.get_component_by_page(catalogId, pageId, siteId, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PageSlotComponentsApi->getComponentByPage: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog id
Required
siteId*
String
The site identifier
Required
versionId*
String
The catalog version identifier
Required
Query parameters
Name Description
pageId*
String
Identifier of the page
Required

Responses

Status: 200 - List of components defined for a given page

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


removeComponent

Removes component.

Deletes a specific component item from a content slot for a given catalog and site ids.


/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagescontentslotscomponents/contentslots/{slotId}/components/{componentId}

Usage and SDK Samples

curl -X DELETE\
\
\
"http://localhost:9001/cmswebservices/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagescontentslotscomponents/contentslots/{slotId}/components/{componentId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PageSlotComponentsApi;

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

public class PageSlotComponentsApiExample {

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

        PageSlotComponentsApi apiInstance = new PageSlotComponentsApi();
        String catalogId = catalogId_example; // String | The catalog id
        String componentId = componentId_example; // String | Component identifier of the component to be removed
        String siteId = siteId_example; // String | The site identifier
        String slotId = slotId_example; // String | Content slot identifier containing the component to be removed
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            apiInstance.removeComponent(catalogId, componentId, siteId, slotId, versionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageSlotComponentsApi#removeComponent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PageSlotComponentsApi;

public class PageSlotComponentsApiExample {

    public static void main(String[] args) {
        PageSlotComponentsApi apiInstance = new PageSlotComponentsApi();
        String catalogId = catalogId_example; // String | The catalog id
        String componentId = componentId_example; // String | Component identifier of the component to be removed
        String siteId = siteId_example; // String | The site identifier
        String slotId = slotId_example; // String | Content slot identifier containing the component to be removed
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            apiInstance.removeComponent(catalogId, componentId, siteId, slotId, versionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageSlotComponentsApi#removeComponent");
            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
String *componentId = componentId_example; // Component identifier of the component to be removed
String *siteId = siteId_example; // The site identifier
String *slotId = slotId_example; // Content slot identifier containing the component to be removed
String *versionId = versionId_example; // The catalog version identifier

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

// Removes component.
[apiInstance removeComponentWith:catalogId
    componentId:componentId
    siteId:siteId
    slotId:slotId
    versionId:versionId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.PageSlotComponentsApi()
var catalogId = catalogId_example; // {{String}} The catalog id
var componentId = componentId_example; // {{String}} Component identifier of the component to be removed
var siteId = siteId_example; // {{String}} The site identifier
var slotId = slotId_example; // {{String}} Content slot identifier containing the component to be removed
var versionId = versionId_example; // {{String}} The catalog version identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeComponent(catalogId, componentId, siteId, slotId, versionId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class removeComponentExample
    {
        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 PageSlotComponentsApi();
            var catalogId = catalogId_example;  // String | The catalog id
            var componentId = componentId_example;  // String | Component identifier of the component to be removed
            var siteId = siteId_example;  // String | The site identifier
            var slotId = slotId_example;  // String | Content slot identifier containing the component to be removed
            var versionId = versionId_example;  // String | The catalog version identifier

            try
            {
                // Removes component.
                apiInstance.removeComponent(catalogId, componentId, siteId, slotId, versionId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PageSlotComponentsApi.removeComponent: " + 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\ApiPageSlotComponentsApi();
$catalogId = catalogId_example; // String | The catalog id
$componentId = componentId_example; // String | Component identifier of the component to be removed
$siteId = siteId_example; // String | The site identifier
$slotId = slotId_example; // String | Content slot identifier containing the component to be removed
$versionId = versionId_example; // String | The catalog version identifier

try {
    $api_instance->removeComponent($catalogId, $componentId, $siteId, $slotId, $versionId);
} catch (Exception $e) {
    echo 'Exception when calling PageSlotComponentsApi->removeComponent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PageSlotComponentsApi;

# 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::PageSlotComponentsApi->new();
my $catalogId = catalogId_example; # String | The catalog id
my $componentId = componentId_example; # String | Component identifier of the component to be removed
my $siteId = siteId_example; # String | The site identifier
my $slotId = slotId_example; # String | Content slot identifier containing the component to be removed
my $versionId = versionId_example; # String | The catalog version identifier

eval { 
    $api_instance->removeComponent(catalogId => $catalogId, componentId => $componentId, siteId => $siteId, slotId => $slotId, versionId => $versionId);
};
if ($@) {
    warn "Exception when calling PageSlotComponentsApi->removeComponent: $@\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.PageSlotComponentsApi()
catalogId = catalogId_example # String | The catalog id
componentId = componentId_example # String | Component identifier of the component to be removed
siteId = siteId_example # String | The site identifier
slotId = slotId_example # String | Content slot identifier containing the component to be removed
versionId = versionId_example # String | The catalog version identifier

try: 
    # Removes component.
    api_instance.remove_component(catalogId, componentId, siteId, slotId, versionId)
except ApiException as e:
    print("Exception when calling PageSlotComponentsApi->removeComponent: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog id
Required
componentId*
String
Component identifier of the component to be removed
Required
siteId*
String
The site identifier
Required
slotId*
String
Content slot identifier containing the component to be removed
Required
versionId*
String
The catalog version identifier
Required

Responses

Status: 400 - When the component or slot cannot be found (CMSItemNotFoundException) or when the component slot does not contain the component (ComponentNotFoundInSlotException)

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


replaceComponent

Moves component.

Relocates a specific component instance to a different content slot by changing its position within the content slot on a given page.


/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagescontentslotscomponents/pages/{pageId}/contentslots/{slotId}/components/{componentId}

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/cmswebservices/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagescontentslotscomponents/pages/{pageId}/contentslots/{slotId}/components/{componentId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PageSlotComponentsApi;

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

public class PageSlotComponentsApiExample {

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

        PageSlotComponentsApi apiInstance = new PageSlotComponentsApi();
        PageContentSlotComponentData body = ; // PageContentSlotComponentData | 
        String catalogId = catalogId_example; // String | The catalog id
        String componentId = componentId_example; // String | Component identifier
        String pageId = pageId_example; // String | Page identifier
        String siteId = siteId_example; // String | The site identifier
        String slotId = slotId_example; // String | Content slot identifier
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            PageContentSlotComponentData result = apiInstance.replaceComponent(body, catalogId, componentId, pageId, siteId, slotId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageSlotComponentsApi#replaceComponent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PageSlotComponentsApi;

public class PageSlotComponentsApiExample {

    public static void main(String[] args) {
        PageSlotComponentsApi apiInstance = new PageSlotComponentsApi();
        PageContentSlotComponentData body = ; // PageContentSlotComponentData | 
        String catalogId = catalogId_example; // String | The catalog id
        String componentId = componentId_example; // String | Component identifier
        String pageId = pageId_example; // String | Page identifier
        String siteId = siteId_example; // String | The site identifier
        String slotId = slotId_example; // String | Content slot identifier
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            PageContentSlotComponentData result = apiInstance.replaceComponent(body, catalogId, componentId, pageId, siteId, slotId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageSlotComponentsApi#replaceComponent");
            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"];
PageContentSlotComponentData *body = ; // 
String *catalogId = catalogId_example; // The catalog id
String *componentId = componentId_example; // Component identifier
String *pageId = pageId_example; // Page identifier
String *siteId = siteId_example; // The site identifier
String *slotId = slotId_example; // Content slot identifier
String *versionId = versionId_example; // The catalog version identifier

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

// Moves component.
[apiInstance replaceComponentWith:body
    catalogId:catalogId
    componentId:componentId
    pageId:pageId
    siteId:siteId
    slotId:slotId
    versionId:versionId
              completionHandler: ^(PageContentSlotComponentData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.PageSlotComponentsApi()
var body = ; // {{PageContentSlotComponentData}} 
var catalogId = catalogId_example; // {{String}} The catalog id
var componentId = componentId_example; // {{String}} Component identifier
var pageId = pageId_example; // {{String}} Page identifier
var siteId = siteId_example; // {{String}} The site identifier
var slotId = slotId_example; // {{String}} Content slot identifier
var versionId = versionId_example; // {{String}} The catalog version identifier

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

namespace Example
{
    public class replaceComponentExample
    {
        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 PageSlotComponentsApi();
            var body = new PageContentSlotComponentData(); // PageContentSlotComponentData | 
            var catalogId = catalogId_example;  // String | The catalog id
            var componentId = componentId_example;  // String | Component identifier
            var pageId = pageId_example;  // String | Page identifier
            var siteId = siteId_example;  // String | The site identifier
            var slotId = slotId_example;  // String | Content slot identifier
            var versionId = versionId_example;  // String | The catalog version identifier

            try
            {
                // Moves component.
                PageContentSlotComponentData result = apiInstance.replaceComponent(body, catalogId, componentId, pageId, siteId, slotId, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PageSlotComponentsApi.replaceComponent: " + 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\ApiPageSlotComponentsApi();
$body = ; // PageContentSlotComponentData | 
$catalogId = catalogId_example; // String | The catalog id
$componentId = componentId_example; // String | Component identifier
$pageId = pageId_example; // String | Page identifier
$siteId = siteId_example; // String | The site identifier
$slotId = slotId_example; // String | Content slot identifier
$versionId = versionId_example; // String | The catalog version identifier

try {
    $result = $api_instance->replaceComponent($body, $catalogId, $componentId, $pageId, $siteId, $slotId, $versionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PageSlotComponentsApi->replaceComponent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PageSlotComponentsApi;

# 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::PageSlotComponentsApi->new();
my $body = WWW::SwaggerClient::Object::PageContentSlotComponentData->new(); # PageContentSlotComponentData | 
my $catalogId = catalogId_example; # String | The catalog id
my $componentId = componentId_example; # String | Component identifier
my $pageId = pageId_example; # String | Page identifier
my $siteId = siteId_example; # String | The site identifier
my $slotId = slotId_example; # String | Content slot identifier
my $versionId = versionId_example; # String | The catalog version identifier

eval { 
    my $result = $api_instance->replaceComponent(body => $body, catalogId => $catalogId, componentId => $componentId, pageId => $pageId, siteId => $siteId, slotId => $slotId, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PageSlotComponentsApi->replaceComponent: $@\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.PageSlotComponentsApi()
body =  # PageContentSlotComponentData | 
catalogId = catalogId_example # String | The catalog id
componentId = componentId_example # String | Component identifier
pageId = pageId_example # String | Page identifier
siteId = siteId_example # String | The site identifier
slotId = slotId_example # String | Content slot identifier
versionId = versionId_example # String | The catalog version identifier

try: 
    # Moves component.
    api_response = api_instance.replace_component(body, catalogId, componentId, pageId, siteId, slotId, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PageSlotComponentsApi->replaceComponent: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog id
Required
componentId*
String
Component identifier
Required
pageId*
String
Page identifier
Required
siteId*
String
The site identifier
Required
slotId*
String
Content slot identifier
Required
versionId*
String
The catalog version identifier
Required
Body parameters
Name Description
body *

Responses

Status: 200 - The updated PageContentSlotComponentData

Status: 400 - If it cannot find the content item (CMSItemNotFoundException) or if there is any validation error (WebserviceValidationException) or if component is not allowed in slot (ComponentNotAllowedInSlotException).

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


PageSlotContainers

getContainersByPage

Gets containers by page.

Fetches a list of available containers on a given page.


/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagescontentslotscontainers

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagescontentslotscontainers?pageId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PageSlotContainersApi;

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

public class PageSlotContainersApiExample {

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

        PageSlotContainersApi apiInstance = new PageSlotContainersApi();
        String catalogId = catalogId_example; // String | The catalog id
        String pageId = pageId_example; // String | The page identifier
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            PageContentSlotContainerList result = apiInstance.getContainersByPage(catalogId, pageId, siteId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageSlotContainersApi#getContainersByPage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PageSlotContainersApi;

public class PageSlotContainersApiExample {

    public static void main(String[] args) {
        PageSlotContainersApi apiInstance = new PageSlotContainersApi();
        String catalogId = catalogId_example; // String | The catalog id
        String pageId = pageId_example; // String | The page identifier
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            PageContentSlotContainerList result = apiInstance.getContainersByPage(catalogId, pageId, siteId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageSlotContainersApi#getContainersByPage");
            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
String *pageId = pageId_example; // The page identifier
String *siteId = siteId_example; // The site identifier
String *versionId = versionId_example; // The catalog version identifier

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

// Gets containers by page.
[apiInstance getContainersByPageWith:catalogId
    pageId:pageId
    siteId:siteId
    versionId:versionId
              completionHandler: ^(PageContentSlotContainerList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.PageSlotContainersApi()
var catalogId = catalogId_example; // {{String}} The catalog id
var pageId = pageId_example; // {{String}} The page identifier
var siteId = siteId_example; // {{String}} The site identifier
var versionId = versionId_example; // {{String}} The catalog version identifier

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

namespace Example
{
    public class getContainersByPageExample
    {
        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 PageSlotContainersApi();
            var catalogId = catalogId_example;  // String | The catalog id
            var pageId = pageId_example;  // String | The page identifier
            var siteId = siteId_example;  // String | The site identifier
            var versionId = versionId_example;  // String | The catalog version identifier

            try
            {
                // Gets containers by page.
                PageContentSlotContainerList result = apiInstance.getContainersByPage(catalogId, pageId, siteId, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PageSlotContainersApi.getContainersByPage: " + 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\ApiPageSlotContainersApi();
$catalogId = catalogId_example; // String | The catalog id
$pageId = pageId_example; // String | The page identifier
$siteId = siteId_example; // String | The site identifier
$versionId = versionId_example; // String | The catalog version identifier

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

# 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::PageSlotContainersApi->new();
my $catalogId = catalogId_example; # String | The catalog id
my $pageId = pageId_example; # String | The page identifier
my $siteId = siteId_example; # String | The site identifier
my $versionId = versionId_example; # String | The catalog version identifier

eval { 
    my $result = $api_instance->getContainersByPage(catalogId => $catalogId, pageId => $pageId, siteId => $siteId, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PageSlotContainersApi->getContainersByPage: $@\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.PageSlotContainersApi()
catalogId = catalogId_example # String | The catalog id
pageId = pageId_example # String | The page identifier
siteId = siteId_example # String | The site identifier
versionId = versionId_example # String | The catalog version identifier

try: 
    # Gets containers by page.
    api_response = api_instance.get_containers_by_page(catalogId, pageId, siteId, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PageSlotContainersApi->getContainersByPage: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog id
Required
siteId*
String
The site identifier
Required
versionId*
String
The catalog version identifier
Required
Query parameters
Name Description
pageId*
String
The page identifier
Required

Responses

Status: 200 - The list of page content slot containers

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


PageSlotRestrictions

getTypeRestrictionForContentSlot

Gets type restrictions for content slot.

Retrieves a list of available type restrictions for a given page id and content slot id.


/v1/catalogs/{catalogId}/versions/{versionId}/pages/{pageId}/contentslots/{slotId}/typerestrictions

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/catalogs/{catalogId}/versions/{versionId}/pages/{pageId}/contentslots/{slotId}/typerestrictions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PageSlotRestrictionsApi;

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

public class PageSlotRestrictionsApiExample {

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

        PageSlotRestrictionsApi apiInstance = new PageSlotRestrictionsApi();
        String catalogId = catalogId_example; // String | The catalog id
        String pageId = pageId_example; // String | Page identifier
        String slotId = slotId_example; // String | Content slot identifier
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            ContentSlotTypeRestrictions result = apiInstance.getTypeRestrictionForContentSlot(catalogId, pageId, slotId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageSlotRestrictionsApi#getTypeRestrictionForContentSlot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PageSlotRestrictionsApi;

public class PageSlotRestrictionsApiExample {

    public static void main(String[] args) {
        PageSlotRestrictionsApi apiInstance = new PageSlotRestrictionsApi();
        String catalogId = catalogId_example; // String | The catalog id
        String pageId = pageId_example; // String | Page identifier
        String slotId = slotId_example; // String | Content slot identifier
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            ContentSlotTypeRestrictions result = apiInstance.getTypeRestrictionForContentSlot(catalogId, pageId, slotId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageSlotRestrictionsApi#getTypeRestrictionForContentSlot");
            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
String *pageId = pageId_example; // Page identifier
String *slotId = slotId_example; // Content slot identifier
String *versionId = versionId_example; // The catalog version identifier

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

// Gets type restrictions for content slot.
[apiInstance getTypeRestrictionForContentSlotWith:catalogId
    pageId:pageId
    slotId:slotId
    versionId:versionId
              completionHandler: ^(ContentSlotTypeRestrictions output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.PageSlotRestrictionsApi()
var catalogId = catalogId_example; // {{String}} The catalog id
var pageId = pageId_example; // {{String}} Page identifier
var slotId = slotId_example; // {{String}} Content slot identifier
var versionId = versionId_example; // {{String}} The catalog version identifier

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

namespace Example
{
    public class getTypeRestrictionForContentSlotExample
    {
        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 PageSlotRestrictionsApi();
            var catalogId = catalogId_example;  // String | The catalog id
            var pageId = pageId_example;  // String | Page identifier
            var slotId = slotId_example;  // String | Content slot identifier
            var versionId = versionId_example;  // String | The catalog version identifier

            try
            {
                // Gets type restrictions for content slot.
                ContentSlotTypeRestrictions result = apiInstance.getTypeRestrictionForContentSlot(catalogId, pageId, slotId, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PageSlotRestrictionsApi.getTypeRestrictionForContentSlot: " + 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\ApiPageSlotRestrictionsApi();
$catalogId = catalogId_example; // String | The catalog id
$pageId = pageId_example; // String | Page identifier
$slotId = slotId_example; // String | Content slot identifier
$versionId = versionId_example; // String | The catalog version identifier

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

# 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::PageSlotRestrictionsApi->new();
my $catalogId = catalogId_example; # String | The catalog id
my $pageId = pageId_example; # String | Page identifier
my $slotId = slotId_example; # String | Content slot identifier
my $versionId = versionId_example; # String | The catalog version identifier

eval { 
    my $result = $api_instance->getTypeRestrictionForContentSlot(catalogId => $catalogId, pageId => $pageId, slotId => $slotId, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PageSlotRestrictionsApi->getTypeRestrictionForContentSlot: $@\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.PageSlotRestrictionsApi()
catalogId = catalogId_example # String | The catalog id
pageId = pageId_example # String | Page identifier
slotId = slotId_example # String | Content slot identifier
versionId = versionId_example # String | The catalog version identifier

try: 
    # Gets type restrictions for content slot.
    api_response = api_instance.get_type_restriction_for_content_slot(catalogId, pageId, slotId, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PageSlotRestrictionsApi->getTypeRestrictionForContentSlot: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog id
Required
pageId*
String
Page identifier
Required
slotId*
String
Content slot identifier
Required
versionId*
String
The catalog version identifier
Required

Responses

Status: 200 - DTO providing the mapping

Status: 400 - When the page/slot cannot be found (CMSItemNotFoundException)

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


searchTypeRestrictionBySlotIds

Gets type restrictions for the provided content slots.

Retrieves a list of available type restrictions for the given slotId's.


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

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/cmswebservices/v1/catalogs/{catalogId}/versions/{versionId}/pages/{pageId}/typerestrictions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PageSlotRestrictionsApi;

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

public class PageSlotRestrictionsApiExample {

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

        PageSlotRestrictionsApi apiInstance = new PageSlotRestrictionsApi();
        CMSContentSlotIdList body = ; // CMSContentSlotIdList | 
        String catalogId = catalogId_example; // String | The catalog id
        String pageId = pageId_example; // String | Page identifier
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            array[ContentSlotTypeRestrictions] result = apiInstance.searchTypeRestrictionBySlotIds(body, catalogId, pageId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageSlotRestrictionsApi#searchTypeRestrictionBySlotIds");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PageSlotRestrictionsApi;

public class PageSlotRestrictionsApiExample {

    public static void main(String[] args) {
        PageSlotRestrictionsApi apiInstance = new PageSlotRestrictionsApi();
        CMSContentSlotIdList body = ; // CMSContentSlotIdList | 
        String catalogId = catalogId_example; // String | The catalog id
        String pageId = pageId_example; // String | Page identifier
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            array[ContentSlotTypeRestrictions] result = apiInstance.searchTypeRestrictionBySlotIds(body, catalogId, pageId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageSlotRestrictionsApi#searchTypeRestrictionBySlotIds");
            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"];
CMSContentSlotIdList *body = ; // 
String *catalogId = catalogId_example; // The catalog id
String *pageId = pageId_example; // Page identifier
String *versionId = versionId_example; // The catalog version identifier

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

// Gets type restrictions for the provided content slots.
[apiInstance searchTypeRestrictionBySlotIdsWith:body
    catalogId:catalogId
    pageId:pageId
    versionId:versionId
              completionHandler: ^(array[ContentSlotTypeRestrictions] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.PageSlotRestrictionsApi()
var body = ; // {{CMSContentSlotIdList}} 
var catalogId = catalogId_example; // {{String}} The catalog id
var pageId = pageId_example; // {{String}} Page identifier
var versionId = versionId_example; // {{String}} The catalog version identifier

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

namespace Example
{
    public class searchTypeRestrictionBySlotIdsExample
    {
        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 PageSlotRestrictionsApi();
            var body = new CMSContentSlotIdList(); // CMSContentSlotIdList | 
            var catalogId = catalogId_example;  // String | The catalog id
            var pageId = pageId_example;  // String | Page identifier
            var versionId = versionId_example;  // String | The catalog version identifier

            try
            {
                // Gets type restrictions for the provided content slots.
                array[ContentSlotTypeRestrictions] result = apiInstance.searchTypeRestrictionBySlotIds(body, catalogId, pageId, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PageSlotRestrictionsApi.searchTypeRestrictionBySlotIds: " + 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\ApiPageSlotRestrictionsApi();
$body = ; // CMSContentSlotIdList | 
$catalogId = catalogId_example; // String | The catalog id
$pageId = pageId_example; // String | Page identifier
$versionId = versionId_example; // String | The catalog version identifier

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

# 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::PageSlotRestrictionsApi->new();
my $body = WWW::SwaggerClient::Object::CMSContentSlotIdList->new(); # CMSContentSlotIdList | 
my $catalogId = catalogId_example; # String | The catalog id
my $pageId = pageId_example; # String | Page identifier
my $versionId = versionId_example; # String | The catalog version identifier

eval { 
    my $result = $api_instance->searchTypeRestrictionBySlotIds(body => $body, catalogId => $catalogId, pageId => $pageId, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PageSlotRestrictionsApi->searchTypeRestrictionBySlotIds: $@\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.PageSlotRestrictionsApi()
body =  # CMSContentSlotIdList | 
catalogId = catalogId_example # String | The catalog id
pageId = pageId_example # String | Page identifier
versionId = versionId_example # String | The catalog version identifier

try: 
    # Gets type restrictions for the provided content slots.
    api_response = api_instance.search_type_restriction_by_slot_ids(body, catalogId, pageId, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PageSlotRestrictionsApi->searchTypeRestrictionBySlotIds: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog id
Required
pageId*
String
Page identifier
Required
versionId*
String
The catalog version identifier
Required
Body parameters
Name Description
body *

Responses

Status: 200 - DTO providing the mapping

Status: 400 - When slot(s) for slotId(s) cannot be found (CMSItemNotFoundException)

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


PageSlots

getContentSlotByPage

Gets content slots by page.

Retrieves a list of available content slots defined on the page specified by the page id.


/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagescontentslots

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagescontentslots?pageId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PageSlotsApi;

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

public class PageSlotsApiExample {

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

        PageSlotsApi apiInstance = new PageSlotsApi();
        String catalogId = catalogId_example; // String | The catalog id
        String pageId = pageId_example; // String | Identifier of the page
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            PageContentSlotListData result = apiInstance.getContentSlotByPage(catalogId, pageId, siteId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageSlotsApi#getContentSlotByPage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PageSlotsApi;

public class PageSlotsApiExample {

    public static void main(String[] args) {
        PageSlotsApi apiInstance = new PageSlotsApi();
        String catalogId = catalogId_example; // String | The catalog id
        String pageId = pageId_example; // String | Identifier of the page
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            PageContentSlotListData result = apiInstance.getContentSlotByPage(catalogId, pageId, siteId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageSlotsApi#getContentSlotByPage");
            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
String *pageId = pageId_example; // Identifier of the page
String *siteId = siteId_example; // The site identifier
String *versionId = versionId_example; // The catalog version identifier

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

// Gets content slots by page.
[apiInstance getContentSlotByPageWith:catalogId
    pageId:pageId
    siteId:siteId
    versionId:versionId
              completionHandler: ^(PageContentSlotListData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.PageSlotsApi()
var catalogId = catalogId_example; // {{String}} The catalog id
var pageId = pageId_example; // {{String}} Identifier of the page
var siteId = siteId_example; // {{String}} The site identifier
var versionId = versionId_example; // {{String}} The catalog version identifier

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

namespace Example
{
    public class getContentSlotByPageExample
    {
        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 PageSlotsApi();
            var catalogId = catalogId_example;  // String | The catalog id
            var pageId = pageId_example;  // String | Identifier of the page
            var siteId = siteId_example;  // String | The site identifier
            var versionId = versionId_example;  // String | The catalog version identifier

            try
            {
                // Gets content slots by page.
                PageContentSlotListData result = apiInstance.getContentSlotByPage(catalogId, pageId, siteId, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PageSlotsApi.getContentSlotByPage: " + 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\ApiPageSlotsApi();
$catalogId = catalogId_example; // String | The catalog id
$pageId = pageId_example; // String | Identifier of the page
$siteId = siteId_example; // String | The site identifier
$versionId = versionId_example; // String | The catalog version identifier

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

# 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::PageSlotsApi->new();
my $catalogId = catalogId_example; # String | The catalog id
my $pageId = pageId_example; # String | Identifier of the page
my $siteId = siteId_example; # String | The site identifier
my $versionId = versionId_example; # String | The catalog version identifier

eval { 
    my $result = $api_instance->getContentSlotByPage(catalogId => $catalogId, pageId => $pageId, siteId => $siteId, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PageSlotsApi->getContentSlotByPage: $@\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.PageSlotsApi()
catalogId = catalogId_example # String | The catalog id
pageId = pageId_example # String | Identifier of the page
siteId = siteId_example # String | The site identifier
versionId = versionId_example # String | The catalog version identifier

try: 
    # Gets content slots by page.
    api_response = api_instance.get_content_slot_by_page(catalogId, pageId, siteId, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PageSlotsApi->getContentSlotByPage: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog id
Required
siteId*
String
The site identifier
Required
versionId*
String
The catalog version identifier
Required
Query parameters
Name Description
pageId*
String
Identifier of the page
Required

Responses

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

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


PageTemplates

getPageTemplatesByPageType

Finds page templates by page type.

Returns a holder of a collection of PageTemplateData filtered on the given data passed as query string.


/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagetemplates

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagetemplates?active=&pageTemplateInfo=&pageTypeCode="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PageTemplatesApi;

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

public class PageTemplatesApiExample {

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

        PageTemplatesApi apiInstance = new PageTemplatesApi();
        String catalogId = catalogId_example; // String | The catalog id
        PageTemplateDTO pageTemplateInfo = ; // PageTemplateDTO | Holder of search filters
        String pageTypeCode = pageTypeCode_example; // String | Item type of a page
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The catalog version identifier
        String active = active_example; // String | When set to TRUE, filter the results for active templates
        try {
            PageTemplateListData result = apiInstance.getPageTemplatesByPageType(catalogId, pageTemplateInfo, pageTypeCode, siteId, versionId, active);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageTemplatesApi#getPageTemplatesByPageType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PageTemplatesApi;

public class PageTemplatesApiExample {

    public static void main(String[] args) {
        PageTemplatesApi apiInstance = new PageTemplatesApi();
        String catalogId = catalogId_example; // String | The catalog id
        PageTemplateDTO pageTemplateInfo = ; // PageTemplateDTO | Holder of search filters
        String pageTypeCode = pageTypeCode_example; // String | Item type of a page
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The catalog version identifier
        String active = active_example; // String | When set to TRUE, filter the results for active templates
        try {
            PageTemplateListData result = apiInstance.getPageTemplatesByPageType(catalogId, pageTemplateInfo, pageTypeCode, siteId, versionId, active);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageTemplatesApi#getPageTemplatesByPageType");
            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
PageTemplateDTO *pageTemplateInfo = ; // Holder of search filters
String *pageTypeCode = pageTypeCode_example; // Item type of a page
String *siteId = siteId_example; // The site identifier
String *versionId = versionId_example; // The catalog version identifier
String *active = active_example; // When set to TRUE, filter the results for active templates (optional)

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

// Finds page templates by page type.
[apiInstance getPageTemplatesByPageTypeWith:catalogId
    pageTemplateInfo:pageTemplateInfo
    pageTypeCode:pageTypeCode
    siteId:siteId
    versionId:versionId
    active:active
              completionHandler: ^(PageTemplateListData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.PageTemplatesApi()
var catalogId = catalogId_example; // {{String}} The catalog id
var pageTemplateInfo = ; // {{PageTemplateDTO}} Holder of search filters
var pageTypeCode = pageTypeCode_example; // {{String}} Item type of a page
var siteId = siteId_example; // {{String}} The site identifier
var versionId = versionId_example; // {{String}} The catalog version identifier
var opts = { 
  'active': active_example // {{String}} When set to TRUE, filter the results for active templates
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPageTemplatesByPageType(catalogId, pageTemplateInfo, pageTypeCode, siteId, versionId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPageTemplatesByPageTypeExample
    {
        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 PageTemplatesApi();
            var catalogId = catalogId_example;  // String | The catalog id
            var pageTemplateInfo = new PageTemplateDTO(); // PageTemplateDTO | Holder of search filters
            var pageTypeCode = pageTypeCode_example;  // String | Item type of a page
            var siteId = siteId_example;  // String | The site identifier
            var versionId = versionId_example;  // String | The catalog version identifier
            var active = active_example;  // String | When set to TRUE, filter the results for active templates (optional) 

            try
            {
                // Finds page templates by page type.
                PageTemplateListData result = apiInstance.getPageTemplatesByPageType(catalogId, pageTemplateInfo, pageTypeCode, siteId, versionId, active);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PageTemplatesApi.getPageTemplatesByPageType: " + 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\ApiPageTemplatesApi();
$catalogId = catalogId_example; // String | The catalog id
$pageTemplateInfo = ; // PageTemplateDTO | Holder of search filters
$pageTypeCode = pageTypeCode_example; // String | Item type of a page
$siteId = siteId_example; // String | The site identifier
$versionId = versionId_example; // String | The catalog version identifier
$active = active_example; // String | When set to TRUE, filter the results for active templates

try {
    $result = $api_instance->getPageTemplatesByPageType($catalogId, $pageTemplateInfo, $pageTypeCode, $siteId, $versionId, $active);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PageTemplatesApi->getPageTemplatesByPageType: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PageTemplatesApi;

# 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::PageTemplatesApi->new();
my $catalogId = catalogId_example; # String | The catalog id
my $pageTemplateInfo = ; # PageTemplateDTO | Holder of search filters
my $pageTypeCode = pageTypeCode_example; # String | Item type of a page
my $siteId = siteId_example; # String | The site identifier
my $versionId = versionId_example; # String | The catalog version identifier
my $active = active_example; # String | When set to TRUE, filter the results for active templates

eval { 
    my $result = $api_instance->getPageTemplatesByPageType(catalogId => $catalogId, pageTemplateInfo => $pageTemplateInfo, pageTypeCode => $pageTypeCode, siteId => $siteId, versionId => $versionId, active => $active);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PageTemplatesApi->getPageTemplatesByPageType: $@\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.PageTemplatesApi()
catalogId = catalogId_example # String | The catalog id
pageTemplateInfo =  # PageTemplateDTO | Holder of search filters
pageTypeCode = pageTypeCode_example # String | Item type of a page
siteId = siteId_example # String | The site identifier
versionId = versionId_example # String | The catalog version identifier
active = active_example # String | When set to TRUE, filter the results for active templates (optional)

try: 
    # Finds page templates by page type.
    api_response = api_instance.get_page_templates_by_page_type(catalogId, pageTemplateInfo, pageTypeCode, siteId, versionId, active=active)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PageTemplatesApi->getPageTemplatesByPageType: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog id
Required
siteId*
String
The site identifier
Required
versionId*
String
The catalog version identifier
Required
Query parameters
Name Description
active
String
When set to TRUE, filter the results for active templates
pageTemplateInfo*
PageTemplateDTO
Holder of search filters
Required
pageTypeCode*
String
Item type of a page
Required

Responses

Status: 200 - List of page templates

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getPageTemplatesByPageUuid

Finds page templates by page uuid.

Returns the PageTemplateData filtered on the given data passed as query string.


/v1/pagetemplate

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/pagetemplate?pageUuid="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PageTemplatesApi;

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

public class PageTemplatesApiExample {

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

        PageTemplatesApi apiInstance = new PageTemplatesApi();
        String pageUuid = pageUuid_example; // String | page uuid
        try {
            PageTemplateData result = apiInstance.getPageTemplatesByPageUuid(pageUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageTemplatesApi#getPageTemplatesByPageUuid");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PageTemplatesApi;

public class PageTemplatesApiExample {

    public static void main(String[] args) {
        PageTemplatesApi apiInstance = new PageTemplatesApi();
        String pageUuid = pageUuid_example; // String | page uuid
        try {
            PageTemplateData result = apiInstance.getPageTemplatesByPageUuid(pageUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageTemplatesApi#getPageTemplatesByPageUuid");
            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 *pageUuid = pageUuid_example; // page uuid

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

// Finds page templates by page uuid.
[apiInstance getPageTemplatesByPageUuidWith:pageUuid
              completionHandler: ^(PageTemplateData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.PageTemplatesApi()
var pageUuid = pageUuid_example; // {{String}} page uuid

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

namespace Example
{
    public class getPageTemplatesByPageUuidExample
    {
        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 PageTemplatesApi();
            var pageUuid = pageUuid_example;  // String | page uuid

            try
            {
                // Finds page templates by page uuid.
                PageTemplateData result = apiInstance.getPageTemplatesByPageUuid(pageUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PageTemplatesApi.getPageTemplatesByPageUuid: " + 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\ApiPageTemplatesApi();
$pageUuid = pageUuid_example; // String | page uuid

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

# 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::PageTemplatesApi->new();
my $pageUuid = pageUuid_example; # String | page uuid

eval { 
    my $result = $api_instance->getPageTemplatesByPageUuid(pageUuid => $pageUuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PageTemplatesApi->getPageTemplatesByPageUuid: $@\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.PageTemplatesApi()
pageUuid = pageUuid_example # String | page uuid

try: 
    # Finds page templates by page uuid.
    api_response = api_instance.get_page_templates_by_page_uuid(pageUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PageTemplatesApi->getPageTemplatesByPageUuid: %s\n" % e)

Parameters

Query parameters
Name Description
pageUuid*
String
page uuid
Required

Responses

Status: 200 - Get a page template

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


PageTypeRestrictions

getRestictionTypesByPageType

Gets restriction types by page type.

Retrieves a list of available restrictions types for a given page type.


/v1/pagetypesrestrictiontypes

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/pagetypesrestrictiontypes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PageTypeRestrictionsApi;

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

public class PageTypeRestrictionsApiExample {

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

        PageTypeRestrictionsApi apiInstance = new PageTypeRestrictionsApi();
        try {
            PageTypeRestrictionTypeListData result = apiInstance.getRestictionTypesByPageType();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageTypeRestrictionsApi#getRestictionTypesByPageType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PageTypeRestrictionsApi;

public class PageTypeRestrictionsApiExample {

    public static void main(String[] args) {
        PageTypeRestrictionsApi apiInstance = new PageTypeRestrictionsApi();
        try {
            PageTypeRestrictionTypeListData result = apiInstance.getRestictionTypesByPageType();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageTypeRestrictionsApi#getRestictionTypesByPageType");
            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"];

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

// Gets restriction types by page type.
[apiInstance getRestictionTypesByPageTypeWithCompletionHandler: 
              ^(PageTypeRestrictionTypeListData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.PageTypeRestrictionsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRestictionTypesByPageType(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getRestictionTypesByPageTypeExample
    {
        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 PageTypeRestrictionsApi();

            try
            {
                // Gets restriction types by page type.
                PageTypeRestrictionTypeListData result = apiInstance.getRestictionTypesByPageType();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PageTypeRestrictionsApi.getRestictionTypesByPageType: " + 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\ApiPageTypeRestrictionsApi();

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

# 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::PageTypeRestrictionsApi->new();

eval { 
    my $result = $api_instance->getRestictionTypesByPageType();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PageTypeRestrictionsApi->getRestictionTypesByPageType: $@\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.PageTypeRestrictionsApi()

try: 
    # Gets restriction types by page type.
    api_response = api_instance.get_restiction_types_by_page_type()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PageTypeRestrictionsApi->getRestictionTypesByPageType: %s\n" % e)

Parameters

Responses

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

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


PageTypes

getAllPageTypes

Finds all page types.

Retrieves a list of available page types.


/v1/pagetypes

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/pagetypes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PageTypesApi;

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

public class PageTypesApiExample {

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

        PageTypesApi apiInstance = new PageTypesApi();
        try {
            PageTypeListData result = apiInstance.getAllPageTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageTypesApi#getAllPageTypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PageTypesApi;

public class PageTypesApiExample {

    public static void main(String[] args) {
        PageTypesApi apiInstance = new PageTypesApi();
        try {
            PageTypeListData result = apiInstance.getAllPageTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PageTypesApi#getAllPageTypes");
            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"];

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

// Finds all page types.
[apiInstance getAllPageTypesWithCompletionHandler: 
              ^(PageTypeListData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.PageTypesApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllPageTypes(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllPageTypesExample
    {
        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 PageTypesApi();

            try
            {
                // Finds all page types.
                PageTypeListData result = apiInstance.getAllPageTypes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PageTypesApi.getAllPageTypes: " + 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\ApiPageTypesApi();

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

# 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::PageTypesApi->new();

eval { 
    my $result = $api_instance->getAllPageTypes();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PageTypesApi->getAllPageTypes: $@\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.PageTypesApi()

try: 
    # Finds all page types.
    api_response = api_instance.get_all_page_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PageTypesApi->getAllPageTypes: %s\n" % e)

Parameters

Responses

Status: 200 - The list of page types

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


Pages

getFallbackPages

Finds fallback pages.

Retrieves a list of available fallback pages for a given page.


/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pages/{pageId}/fallbacks

Usage and SDK Samples

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

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

public class PagesApiExample {

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

        PagesApi apiInstance = new PagesApi();
        String catalogId = catalogId_example; // String | The catalog name
        String pageId = pageId_example; // String | The page identifier
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            UidListData result = apiInstance.getFallbackPages(catalogId, pageId, siteId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PagesApi#getFallbackPages");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PagesApi;

public class PagesApiExample {

    public static void main(String[] args) {
        PagesApi apiInstance = new PagesApi();
        String catalogId = catalogId_example; // String | The catalog name
        String pageId = pageId_example; // String | The page identifier
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            UidListData result = apiInstance.getFallbackPages(catalogId, pageId, siteId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PagesApi#getFallbackPages");
            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 name
String *pageId = pageId_example; // The page identifier
String *siteId = siteId_example; // The site identifier
String *versionId = versionId_example; // The catalog version identifier

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

// Finds fallback pages.
[apiInstance getFallbackPagesWith:catalogId
    pageId:pageId
    siteId:siteId
    versionId:versionId
              completionHandler: ^(UidListData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.PagesApi()
var catalogId = catalogId_example; // {{String}} The catalog name
var pageId = pageId_example; // {{String}} The page identifier
var siteId = siteId_example; // {{String}} The site identifier
var versionId = versionId_example; // {{String}} The catalog version identifier

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

namespace Example
{
    public class getFallbackPagesExample
    {
        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 PagesApi();
            var catalogId = catalogId_example;  // String | The catalog name
            var pageId = pageId_example;  // String | The page identifier
            var siteId = siteId_example;  // String | The site identifier
            var versionId = versionId_example;  // String | The catalog version identifier

            try
            {
                // Finds fallback pages.
                UidListData result = apiInstance.getFallbackPages(catalogId, pageId, siteId, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PagesApi.getFallbackPages: " + 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\ApiPagesApi();
$catalogId = catalogId_example; // String | The catalog name
$pageId = pageId_example; // String | The page identifier
$siteId = siteId_example; // String | The site identifier
$versionId = versionId_example; // String | The catalog version identifier

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

# 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::PagesApi->new();
my $catalogId = catalogId_example; # String | The catalog name
my $pageId = pageId_example; # String | The page identifier
my $siteId = siteId_example; # String | The site identifier
my $versionId = versionId_example; # String | The catalog version identifier

eval { 
    my $result = $api_instance->getFallbackPages(catalogId => $catalogId, pageId => $pageId, siteId => $siteId, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PagesApi->getFallbackPages: $@\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.PagesApi()
catalogId = catalogId_example # String | The catalog name
pageId = pageId_example # String | The page identifier
siteId = siteId_example # String | The site identifier
versionId = versionId_example # String | The catalog version identifier

try: 
    # Finds fallback pages.
    api_response = api_instance.get_fallback_pages(catalogId, pageId, siteId, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PagesApi->getFallbackPages: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog name
Required
pageId*
String
The page identifier
Required
siteId*
String
The site identifier
Required
versionId*
String
The catalog version identifier
Required

Responses

Status: 200 - All fallback pages uid for a given page; empty if the given page is already a fallback page; never null

Status: 400 - When the pageId is invalid (CMSItemNotFoundException).

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getPageByUid

Gets page by uid.

Retrieves a specific page instance that matches given page uid. Deprecated since 6.6, please use GET /v1/sites/{siteId}/cmsitems/{uuid} instead.


/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pages/{pageId}

Usage and SDK Samples

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

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

public class PagesApiExample {

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

        PagesApi apiInstance = new PagesApi();
        String catalogId = catalogId_example; // String | The catalog id
        String pageId = pageId_example; // String | Page identifier
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            AbstractPageData result = apiInstance.getPageByUid(catalogId, pageId, siteId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PagesApi#getPageByUid");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PagesApi;

public class PagesApiExample {

    public static void main(String[] args) {
        PagesApi apiInstance = new PagesApi();
        String catalogId = catalogId_example; // String | The catalog id
        String pageId = pageId_example; // String | Page identifier
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            AbstractPageData result = apiInstance.getPageByUid(catalogId, pageId, siteId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PagesApi#getPageByUid");
            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
String *pageId = pageId_example; // Page identifier
String *siteId = siteId_example; // The site identifier
String *versionId = versionId_example; // The catalog version identifier

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

// Gets page by uid.
[apiInstance getPageByUidWith:catalogId
    pageId:pageId
    siteId:siteId
    versionId:versionId
              completionHandler: ^(AbstractPageData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.PagesApi()
var catalogId = catalogId_example; // {{String}} The catalog id
var pageId = pageId_example; // {{String}} Page identifier
var siteId = siteId_example; // {{String}} The site identifier
var versionId = versionId_example; // {{String}} The catalog version identifier

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

namespace Example
{
    public class getPageByUidExample
    {
        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 PagesApi();
            var catalogId = catalogId_example;  // String | The catalog id
            var pageId = pageId_example;  // String | Page identifier
            var siteId = siteId_example;  // String | The site identifier
            var versionId = versionId_example;  // String | The catalog version identifier

            try
            {
                // Gets page by uid.
                AbstractPageData result = apiInstance.getPageByUid(catalogId, pageId, siteId, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PagesApi.getPageByUid: " + 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\ApiPagesApi();
$catalogId = catalogId_example; // String | The catalog id
$pageId = pageId_example; // String | Page identifier
$siteId = siteId_example; // String | The site identifier
$versionId = versionId_example; // String | The catalog version identifier

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

# 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::PagesApi->new();
my $catalogId = catalogId_example; # String | The catalog id
my $pageId = pageId_example; # String | Page identifier
my $siteId = siteId_example; # String | The site identifier
my $versionId = versionId_example; # String | The catalog version identifier

eval { 
    my $result = $api_instance->getPageByUid(catalogId => $catalogId, pageId => $pageId, siteId => $siteId, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PagesApi->getPageByUid: $@\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.PagesApi()
catalogId = catalogId_example # String | The catalog id
pageId = pageId_example # String | Page identifier
siteId = siteId_example # String | The site identifier
versionId = versionId_example # String | The catalog version identifier

try: 
    # Gets page by uid.
    api_response = api_instance.get_page_by_uid(catalogId, pageId, siteId, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PagesApi->getPageByUid: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog id
Required
pageId*
String
Page identifier
Required
siteId*
String
The site identifier
Required
versionId*
String
The catalog version identifier
Required

Responses

Status: 200 - Page data object

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

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getPagesByType1

Finds pages by type.

Gets all default or variation pages that matches the given page type. Deprecated since 6.6, please use GET /v1/sites/{siteId}/cmsitems{?mask,typeCode,catalogId,catalogVersion,itemSearchParams,sort,pageSize,currentPage} instead.


/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pages

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pages?defaultPage=&typeCode=&uids="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PagesApi;

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

public class PagesApiExample {

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

        PagesApi apiInstance = new PagesApi();
        String catalogId = catalogId_example; // String | The catalog id
        Boolean defaultPage = true; // Boolean | Setting this to true will find all default pages; otherwise find all variation pages
        String siteId = siteId_example; // String | The site identifier
        String typeCode = typeCode_example; // String | The type code of a page
        array[String] uids = ; // array[String] | List of identifier of the pages that we are looking for
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            PageListData result = apiInstance.getPagesByType1(catalogId, defaultPage, siteId, typeCode, uids, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PagesApi#getPagesByType1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PagesApi;

public class PagesApiExample {

    public static void main(String[] args) {
        PagesApi apiInstance = new PagesApi();
        String catalogId = catalogId_example; // String | The catalog id
        Boolean defaultPage = true; // Boolean | Setting this to true will find all default pages; otherwise find all variation pages
        String siteId = siteId_example; // String | The site identifier
        String typeCode = typeCode_example; // String | The type code of a page
        array[String] uids = ; // array[String] | List of identifier of the pages that we are looking for
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            PageListData result = apiInstance.getPagesByType1(catalogId, defaultPage, siteId, typeCode, uids, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PagesApi#getPagesByType1");
            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
Boolean *defaultPage = true; // Setting this to true will find all default pages; otherwise find all variation pages
String *siteId = siteId_example; // The site identifier
String *typeCode = typeCode_example; // The type code of a page
array[String] *uids = ; // List of identifier of the pages that we are looking for
String *versionId = versionId_example; // The catalog version identifier

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

// Finds pages by type.
[apiInstance getPagesByType1With:catalogId
    defaultPage:defaultPage
    siteId:siteId
    typeCode:typeCode
    uids:uids
    versionId:versionId
              completionHandler: ^(PageListData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.PagesApi()
var catalogId = catalogId_example; // {{String}} The catalog id
var defaultPage = true; // {{Boolean}} Setting this to true will find all default pages; otherwise find all variation pages
var siteId = siteId_example; // {{String}} The site identifier
var typeCode = typeCode_example; // {{String}} The type code of a page
var uids = ; // {{array[String]}} List of identifier of the pages that we are looking for
var versionId = versionId_example; // {{String}} The catalog version identifier

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

namespace Example
{
    public class getPagesByType1Example
    {
        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 PagesApi();
            var catalogId = catalogId_example;  // String | The catalog id
            var defaultPage = true;  // Boolean | Setting this to true will find all default pages; otherwise find all variation pages
            var siteId = siteId_example;  // String | The site identifier
            var typeCode = typeCode_example;  // String | The type code of a page
            var uids = new array[String](); // array[String] | List of identifier of the pages that we are looking for
            var versionId = versionId_example;  // String | The catalog version identifier

            try
            {
                // Finds pages by type.
                PageListData result = apiInstance.getPagesByType1(catalogId, defaultPage, siteId, typeCode, uids, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PagesApi.getPagesByType1: " + 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\ApiPagesApi();
$catalogId = catalogId_example; // String | The catalog id
$defaultPage = true; // Boolean | Setting this to true will find all default pages; otherwise find all variation pages
$siteId = siteId_example; // String | The site identifier
$typeCode = typeCode_example; // String | The type code of a page
$uids = ; // array[String] | List of identifier of the pages that we are looking for
$versionId = versionId_example; // String | The catalog version identifier

try {
    $result = $api_instance->getPagesByType1($catalogId, $defaultPage, $siteId, $typeCode, $uids, $versionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PagesApi->getPagesByType1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PagesApi;

# 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::PagesApi->new();
my $catalogId = catalogId_example; # String | The catalog id
my $defaultPage = true; # Boolean | Setting this to true will find all default pages; otherwise find all variation pages
my $siteId = siteId_example; # String | The site identifier
my $typeCode = typeCode_example; # String | The type code of a page
my $uids = []; # array[String] | List of identifier of the pages that we are looking for
my $versionId = versionId_example; # String | The catalog version identifier

eval { 
    my $result = $api_instance->getPagesByType1(catalogId => $catalogId, defaultPage => $defaultPage, siteId => $siteId, typeCode => $typeCode, uids => $uids, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PagesApi->getPagesByType1: $@\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.PagesApi()
catalogId = catalogId_example # String | The catalog id
defaultPage = true # Boolean | Setting this to true will find all default pages; otherwise find all variation pages
siteId = siteId_example # String | The site identifier
typeCode = typeCode_example # String | The type code of a page
uids =  # array[String] | List of identifier of the pages that we are looking for
versionId = versionId_example # String | The catalog version identifier

try: 
    # Finds pages by type.
    api_response = api_instance.get_pages_by_type1(catalogId, defaultPage, siteId, typeCode, uids, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PagesApi->getPagesByType1: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog id
Required
siteId*
String
The site identifier
Required
versionId*
String
The catalog version identifier
Required
Query parameters
Name Description
defaultPage*
Boolean
Setting this to true will find all default pages; otherwise find all variation pages
Required
typeCode*
String
The type code of a page
Required
uids*
array[String]
List of identifier of the pages that we are looking for
Required

Responses

Status: 200 - All default or variation pages for a given page type

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getVariationPages

Finds variation pages.

Retrieves a list of available variation pages uid for a given page.


/v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pages/{pageId}/variations

Usage and SDK Samples

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

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

public class PagesApiExample {

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

        PagesApi apiInstance = new PagesApi();
        String catalogId = catalogId_example; // String | The catalog name
        String pageId = pageId_example; // String | The page identifier
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            UidListData result = apiInstance.getVariationPages(catalogId, pageId, siteId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PagesApi#getVariationPages");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PagesApi;

public class PagesApiExample {

    public static void main(String[] args) {
        PagesApi apiInstance = new PagesApi();
        String catalogId = catalogId_example; // String | The catalog name
        String pageId = pageId_example; // String | The page identifier
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            UidListData result = apiInstance.getVariationPages(catalogId, pageId, siteId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PagesApi#getVariationPages");
            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 name
String *pageId = pageId_example; // The page identifier
String *siteId = siteId_example; // The site identifier
String *versionId = versionId_example; // The catalog version identifier

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

// Finds variation pages.
[apiInstance getVariationPagesWith:catalogId
    pageId:pageId
    siteId:siteId
    versionId:versionId
              completionHandler: ^(UidListData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.PagesApi()
var catalogId = catalogId_example; // {{String}} The catalog name
var pageId = pageId_example; // {{String}} The page identifier
var siteId = siteId_example; // {{String}} The site identifier
var versionId = versionId_example; // {{String}} The catalog version identifier

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

namespace Example
{
    public class getVariationPagesExample
    {
        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 PagesApi();
            var catalogId = catalogId_example;  // String | The catalog name
            var pageId = pageId_example;  // String | The page identifier
            var siteId = siteId_example;  // String | The site identifier
            var versionId = versionId_example;  // String | The catalog version identifier

            try
            {
                // Finds variation pages.
                UidListData result = apiInstance.getVariationPages(catalogId, pageId, siteId, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PagesApi.getVariationPages: " + 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\ApiPagesApi();
$catalogId = catalogId_example; // String | The catalog name
$pageId = pageId_example; // String | The page identifier
$siteId = siteId_example; // String | The site identifier
$versionId = versionId_example; // String | The catalog version identifier

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

# 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::PagesApi->new();
my $catalogId = catalogId_example; # String | The catalog name
my $pageId = pageId_example; # String | The page identifier
my $siteId = siteId_example; # String | The site identifier
my $versionId = versionId_example; # String | The catalog version identifier

eval { 
    my $result = $api_instance->getVariationPages(catalogId => $catalogId, pageId => $pageId, siteId => $siteId, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PagesApi->getVariationPages: $@\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.PagesApi()
catalogId = catalogId_example # String | The catalog name
pageId = pageId_example # String | The page identifier
siteId = siteId_example # String | The site identifier
versionId = versionId_example # String | The catalog version identifier

try: 
    # Finds variation pages.
    api_response = api_instance.get_variation_pages(catalogId, pageId, siteId, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PagesApi->getVariationPages: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog name
Required
pageId*
String
The page identifier
Required
siteId*
String
The site identifier
Required
versionId*
String
The catalog version identifier
Required

Responses

Status: 200 - All variation pages uid for a given page; empty if the given page is already a variation page; never null.

Status: 400 - When the pageId is invalid (CMSItemNotFoundException).

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


ProductCategories

getCategoryByCode

Gets category by code.

Finds a specific category that matches given product category code.


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

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/productcatalogs/{catalogId}/versions/{versionId}/categories/{code}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductCategoriesApi;

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

public class ProductCategoriesApiExample {

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

        ProductCategoriesApi apiInstance = new ProductCategoriesApi();
        String catalogId = catalogId_example; // String | The catalog id
        String code = code_example; // String | Category code
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            Category result = apiInstance.getCategoryByCode(catalogId, code, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCategoriesApi#getCategoryByCode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductCategoriesApi;

public class ProductCategoriesApiExample {

    public static void main(String[] args) {
        ProductCategoriesApi apiInstance = new ProductCategoriesApi();
        String catalogId = catalogId_example; // String | The catalog id
        String code = code_example; // String | Category code
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            Category result = apiInstance.getCategoryByCode(catalogId, code, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCategoriesApi#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 *catalogId = catalogId_example; // The catalog id
String *code = code_example; // Category code
String *versionId = versionId_example; // The catalog version identifier

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

// Gets category by code.
[apiInstance getCategoryByCodeWith:catalogId
    code:code
    versionId:versionId
              completionHandler: ^(Category output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.ProductCategoriesApi()
var catalogId = catalogId_example; // {{String}} The catalog id
var code = code_example; // {{String}} Category code
var versionId = versionId_example; // {{String}} The catalog version identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCategoryByCode(catalogId, code, versionId, 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 ProductCategoriesApi();
            var catalogId = catalogId_example;  // String | The catalog id
            var code = code_example;  // String | Category code
            var versionId = versionId_example;  // String | The catalog version identifier

            try
            {
                // Gets category by code.
                Category result = apiInstance.getCategoryByCode(catalogId, code, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductCategoriesApi.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\ApiProductCategoriesApi();
$catalogId = catalogId_example; // String | The catalog id
$code = code_example; // String | Category code
$versionId = versionId_example; // String | The catalog version identifier

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

# 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::ProductCategoriesApi->new();
my $catalogId = catalogId_example; # String | The catalog id
my $code = code_example; # String | Category code
my $versionId = versionId_example; # String | The catalog version identifier

eval { 
    my $result = $api_instance->getCategoryByCode(catalogId => $catalogId, code => $code, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductCategoriesApi->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.ProductCategoriesApi()
catalogId = catalogId_example # String | The catalog id
code = code_example # String | Category code
versionId = versionId_example # String | The catalog version identifier

try: 
    # Gets category by code.
    api_response = api_instance.get_category_by_code(catalogId, code, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductCategoriesApi->getCategoryByCode: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog id
Required
code*
String
Category code
Required
versionId*
String
The catalog version identifier
Required

Responses

Status: 200 - CategoryData

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


getProductCategoriesByText

Finds product categories by text.

Retrieves a list of available product categories that match 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/cmswebservices/v1/productcatalogs/{catalogId}/versions/{versionId}/categories?currentPage=&mask=&pageSize=&pageableInfo=&sort=&text="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductCategoriesApi;

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

public class ProductCategoriesApiExample {

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

        ProductCategoriesApi apiInstance = new ProductCategoriesApi();
        String catalogId = catalogId_example; // String | The catalog id
        String pageSize = pageSize_example; // String | The maximum number of elements in the result list.
        Pageable pageableInfo = ; // Pageable | Defines the pageSize, currentPage and sorting order
        String versionId = versionId_example; // String | The catalog version identifier
        String currentPage = currentPage_example; // String | The requested page number
        String mask = mask_example; // String | The string value on which products will be filtered
        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. Deprecated, use mask instead!
        try {
            CategoryDataList result = apiInstance.getProductCategoriesByText(catalogId, pageSize, pageableInfo, versionId, currentPage, mask, sort, text);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCategoriesApi#getProductCategoriesByText");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductCategoriesApi;

public class ProductCategoriesApiExample {

    public static void main(String[] args) {
        ProductCategoriesApi apiInstance = new ProductCategoriesApi();
        String catalogId = catalogId_example; // String | The catalog id
        String pageSize = pageSize_example; // String | The maximum number of elements in the result list.
        Pageable pageableInfo = ; // Pageable | Defines the pageSize, currentPage and sorting order
        String versionId = versionId_example; // String | The catalog version identifier
        String currentPage = currentPage_example; // String | The requested page number
        String mask = mask_example; // String | The string value on which products will be filtered
        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. Deprecated, use mask instead!
        try {
            CategoryDataList result = apiInstance.getProductCategoriesByText(catalogId, pageSize, pageableInfo, versionId, currentPage, mask, sort, text);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductCategoriesApi#getProductCategoriesByText");
            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
String *pageSize = pageSize_example; // The maximum number of elements in the result list.
Pageable *pageableInfo = ; // Defines the pageSize, currentPage and sorting order
String *versionId = versionId_example; // The catalog version identifier
String *currentPage = currentPage_example; // The requested page number (optional)
String *mask = mask_example; // The string value on which products will be filtered (optional)
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. Deprecated, use mask instead! (optional)

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

// Finds product categories by text.
[apiInstance getProductCategoriesByTextWith:catalogId
    pageSize:pageSize
    pageableInfo:pageableInfo
    versionId:versionId
    currentPage:currentPage
    mask:mask
    sort:sort
    text:text
              completionHandler: ^(CategoryDataList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.ProductCategoriesApi()
var catalogId = catalogId_example; // {{String}} The catalog id
var pageSize = pageSize_example; // {{String}} The maximum number of elements in the result list.
var pageableInfo = ; // {{Pageable}} Defines the pageSize, currentPage and sorting order
var versionId = versionId_example; // {{String}} The catalog version identifier
var opts = { 
  'currentPage': currentPage_example, // {{String}} The requested page number
  'mask': mask_example, // {{String}} The string value on which products will be filtered
  '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. Deprecated, use mask instead!
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProductCategoriesByText(catalogId, 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 getProductCategoriesByTextExample
    {
        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 ProductCategoriesApi();
            var catalogId = catalogId_example;  // String | The catalog id
            var pageSize = pageSize_example;  // String | The maximum number of elements in the result list.
            var pageableInfo = new Pageable(); // Pageable | Defines the pageSize, currentPage and sorting order
            var versionId = versionId_example;  // String | The catalog version identifier
            var currentPage = currentPage_example;  // String | The requested page number (optional) 
            var mask = mask_example;  // String | The string value on which products will be filtered (optional) 
            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. Deprecated, use mask instead! (optional) 

            try
            {
                // Finds product categories by text.
                CategoryDataList result = apiInstance.getProductCategoriesByText(catalogId, pageSize, pageableInfo, versionId, currentPage, mask, sort, text);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductCategoriesApi.getProductCategoriesByText: " + 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\ApiProductCategoriesApi();
$catalogId = catalogId_example; // String | The catalog id
$pageSize = pageSize_example; // String | The maximum number of elements in the result list.
$pageableInfo = ; // Pageable | Defines the pageSize, currentPage and sorting order
$versionId = versionId_example; // String | The catalog version identifier
$currentPage = currentPage_example; // String | The requested page number
$mask = mask_example; // String | The string value on which products will be filtered
$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. Deprecated, use mask instead!

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

# 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::ProductCategoriesApi->new();
my $catalogId = catalogId_example; # String | The catalog id
my $pageSize = pageSize_example; # String | The maximum number of elements in the result list.
my $pageableInfo = ; # Pageable | Defines the pageSize, currentPage and sorting order
my $versionId = versionId_example; # String | The catalog version identifier
my $currentPage = currentPage_example; # String | The requested page number
my $mask = mask_example; # String | The string value on which products will be filtered
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. Deprecated, use mask instead!

eval { 
    my $result = $api_instance->getProductCategoriesByText(catalogId => $catalogId, pageSize => $pageSize, pageableInfo => $pageableInfo, versionId => $versionId, currentPage => $currentPage, mask => $mask, sort => $sort, text => $text);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductCategoriesApi->getProductCategoriesByText: $@\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.ProductCategoriesApi()
catalogId = catalogId_example # String | The catalog id
pageSize = pageSize_example # String | The maximum number of elements in the result list.
pageableInfo =  # Pageable | Defines the pageSize, currentPage and sorting order
versionId = versionId_example # String | The catalog version identifier
currentPage = currentPage_example # String | The requested page number (optional)
mask = mask_example # String | The string value on which products will be filtered (optional)
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. Deprecated, use mask instead! (optional)

try: 
    # Finds product categories by text.
    api_response = api_instance.get_product_categories_by_text(catalogId, pageSize, pageableInfo, versionId, currentPage=currentPage, mask=mask, sort=sort, text=text)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductCategoriesApi->getProductCategoriesByText: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog id
Required
versionId*
String
The catalog version identifier
Required
Query parameters
Name Description
currentPage
String
The requested page number
mask
String
The string value on which products will be filtered
pageSize*
String
The maximum number of elements in the result list.
Required
pageableInfo*
Pageable
Defines the pageSize, currentPage and sorting order
Required
sort
String
The string field the results will be sorted with
text
String
The string value on which products will be filtered. Deprecated, use mask instead!

Responses

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

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


Products

getProductByCode

Gets product by code.

Retrieves a specific product item that matches given product code.


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

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/productcatalogs/{catalogId}/versions/{versionId}/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 catalogId = catalogId_example; // String | The catalog name
        String code = code_example; // String | Product code
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            Product result = apiInstance.getProductByCode(catalogId, code, versionId);
            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 catalogId = catalogId_example; // String | The catalog name
        String code = code_example; // String | Product code
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            Product result = apiInstance.getProductByCode(catalogId, code, versionId);
            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 *catalogId = catalogId_example; // The catalog name
String *code = code_example; // Product code
String *versionId = versionId_example; // The catalog version identifier

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

// Gets product by code.
[apiInstance getProductByCodeWith:catalogId
    code:code
    versionId:versionId
              completionHandler: ^(Product output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.ProductsApi()
var catalogId = catalogId_example; // {{String}} The catalog name
var code = code_example; // {{String}} Product code
var versionId = versionId_example; // {{String}} The catalog version identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProductByCode(catalogId, code, versionId, 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 catalogId = catalogId_example;  // String | The catalog name
            var code = code_example;  // String | Product code
            var versionId = versionId_example;  // String | The catalog version identifier

            try
            {
                // Gets product by code.
                Product result = apiInstance.getProductByCode(catalogId, code, versionId);
                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();
$catalogId = catalogId_example; // String | The catalog name
$code = code_example; // String | Product code
$versionId = versionId_example; // String | The catalog version identifier

try {
    $result = $api_instance->getProductByCode($catalogId, $code, $versionId);
    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 $catalogId = catalogId_example; # String | The catalog name
my $code = code_example; # String | Product code
my $versionId = versionId_example; # String | The catalog version identifier

eval { 
    my $result = $api_instance->getProductByCode(catalogId => $catalogId, code => $code, versionId => $versionId);
    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()
catalogId = catalogId_example # String | The catalog name
code = code_example # String | Product code
versionId = versionId_example # String | The catalog version identifier

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

Parameters

Path parameters
Name Description
catalogId*
String
The catalog name
Required
code*
String
Product code
Required
versionId*
String
The catalog version identifier
Required

Responses

Status: 200 - ProductData

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


getProductsByText

Gets products by text.

Finds a list of available products that match 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/cmswebservices/v1/productcatalogs/{catalogId}/versions/{versionId}/products?currentPage=&mask=&pageSize=&pageableInfo=&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 catalog name
        String pageSize = pageSize_example; // String | The maximum number of elements in the result list.
        Pageable pageableInfo = ; // Pageable | Defines the pageSize, currentPage and sorting order
        String versionId = versionId_example; // String | The catalog version identifier
        String currentPage = currentPage_example; // String | The requested page number
        String mask = mask_example; // String | The string value on which products will be filtered
        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. Deprecated, use mask instead!
        try {
            ProductDataList result = apiInstance.getProductsByText(catalogId, pageSize, pageableInfo, versionId, currentPage, mask, sort, text);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getProductsByText");
            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 catalog name
        String pageSize = pageSize_example; // String | The maximum number of elements in the result list.
        Pageable pageableInfo = ; // Pageable | Defines the pageSize, currentPage and sorting order
        String versionId = versionId_example; // String | The catalog version identifier
        String currentPage = currentPage_example; // String | The requested page number
        String mask = mask_example; // String | The string value on which products will be filtered
        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. Deprecated, use mask instead!
        try {
            ProductDataList result = apiInstance.getProductsByText(catalogId, pageSize, pageableInfo, versionId, currentPage, mask, sort, text);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getProductsByText");
            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 name
String *pageSize = pageSize_example; // The maximum number of elements in the result list.
Pageable *pageableInfo = ; // Defines the pageSize, currentPage and sorting order
String *versionId = versionId_example; // The catalog version identifier
String *currentPage = currentPage_example; // The requested page number (optional)
String *mask = mask_example; // The string value on which products will be filtered (optional)
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. Deprecated, use mask instead! (optional)

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

// Gets products by text.
[apiInstance getProductsByTextWith:catalogId
    pageSize:pageSize
    pageableInfo:pageableInfo
    versionId:versionId
    currentPage:currentPage
    mask:mask
    sort:sort
    text:text
              completionHandler: ^(ProductDataList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.ProductsApi()
var catalogId = catalogId_example; // {{String}} The catalog name
var pageSize = pageSize_example; // {{String}} The maximum number of elements in the result list.
var pageableInfo = ; // {{Pageable}} Defines the pageSize, currentPage and sorting order
var versionId = versionId_example; // {{String}} The catalog version identifier
var opts = { 
  'currentPage': currentPage_example, // {{String}} The requested page number
  'mask': mask_example, // {{String}} The string value on which products will be filtered
  '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. Deprecated, use mask instead!
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProductsByText(catalogId, 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 getProductsByTextExample
    {
        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 catalog name
            var pageSize = pageSize_example;  // String | The maximum number of elements in the result list.
            var pageableInfo = new Pageable(); // Pageable | Defines the pageSize, currentPage and sorting order
            var versionId = versionId_example;  // String | The catalog version identifier
            var currentPage = currentPage_example;  // String | The requested page number (optional) 
            var mask = mask_example;  // String | The string value on which products will be filtered (optional) 
            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. Deprecated, use mask instead! (optional) 

            try
            {
                // Gets products by text.
                ProductDataList result = apiInstance.getProductsByText(catalogId, pageSize, pageableInfo, versionId, currentPage, mask, sort, text);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.getProductsByText: " + 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 catalog name
$pageSize = pageSize_example; // String | The maximum number of elements in the result list.
$pageableInfo = ; // Pageable | Defines the pageSize, currentPage and sorting order
$versionId = versionId_example; // String | The catalog version identifier
$currentPage = currentPage_example; // String | The requested page number
$mask = mask_example; // String | The string value on which products will be filtered
$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. Deprecated, use mask instead!

try {
    $result = $api_instance->getProductsByText($catalogId, $pageSize, $pageableInfo, $versionId, $currentPage, $mask, $sort, $text);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->getProductsByText: ', $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 catalog name
my $pageSize = pageSize_example; # String | The maximum number of elements in the result list.
my $pageableInfo = ; # Pageable | Defines the pageSize, currentPage and sorting order
my $versionId = versionId_example; # String | The catalog version identifier
my $currentPage = currentPage_example; # String | The requested page number
my $mask = mask_example; # String | The string value on which products will be filtered
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. Deprecated, use mask instead!

eval { 
    my $result = $api_instance->getProductsByText(catalogId => $catalogId, pageSize => $pageSize, pageableInfo => $pageableInfo, versionId => $versionId, currentPage => $currentPage, mask => $mask, sort => $sort, text => $text);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProductsApi->getProductsByText: $@\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 catalog name
pageSize = pageSize_example # String | The maximum number of elements in the result list.
pageableInfo =  # Pageable | Defines the pageSize, currentPage and sorting order
versionId = versionId_example # String | The catalog version identifier
currentPage = currentPage_example # String | The requested page number (optional)
mask = mask_example # String | The string value on which products will be filtered (optional)
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. Deprecated, use mask instead! (optional)

try: 
    # Gets products by text.
    api_response = api_instance.get_products_by_text(catalogId, pageSize, pageableInfo, versionId, currentPage=currentPage, mask=mask, sort=sort, text=text)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductsApi->getProductsByText: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog name
Required
versionId*
String
The catalog version identifier
Required
Query parameters
Name Description
currentPage
String
The requested page number
mask
String
The string value on which products will be filtered
pageSize*
String
The maximum number of elements in the result list.
Required
pageableInfo*
Pageable
Defines the pageSize, currentPage and sorting order
Required
sort
String
The string field the results will be sorted with
text
String
The string value on which products will be filtered. Deprecated, use mask instead!

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


RestrictionTypes

getAllRestrictionTypes

Finds all restriction types.

Retrieves a list of available restriction types.


/v1/restrictiontypes

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/restrictiontypes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RestrictionTypesApi;

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

public class RestrictionTypesApiExample {

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

        RestrictionTypesApi apiInstance = new RestrictionTypesApi();
        try {
            RestrictionTypeListData result = apiInstance.getAllRestrictionTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RestrictionTypesApi#getAllRestrictionTypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RestrictionTypesApi;

public class RestrictionTypesApiExample {

    public static void main(String[] args) {
        RestrictionTypesApi apiInstance = new RestrictionTypesApi();
        try {
            RestrictionTypeListData result = apiInstance.getAllRestrictionTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RestrictionTypesApi#getAllRestrictionTypes");
            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"];

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

// Finds all restriction types.
[apiInstance getAllRestrictionTypesWithCompletionHandler: 
              ^(RestrictionTypeListData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.RestrictionTypesApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllRestrictionTypes(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllRestrictionTypesExample
    {
        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 RestrictionTypesApi();

            try
            {
                // Finds all restriction types.
                RestrictionTypeListData result = apiInstance.getAllRestrictionTypes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RestrictionTypesApi.getAllRestrictionTypes: " + 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\ApiRestrictionTypesApi();

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

# 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::RestrictionTypesApi->new();

eval { 
    my $result = $api_instance->getAllRestrictionTypes();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RestrictionTypesApi->getAllRestrictionTypes: $@\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.RestrictionTypesApi()

try: 
    # Finds all restriction types.
    api_response = api_instance.get_all_restriction_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RestrictionTypesApi->getAllRestrictionTypes: %s\n" % e)

Parameters

Responses

Status: 200 - List of restriction types

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


Sites

getSitesByCatalogs1

Gets sites for catalogs.

Retrieves a list of all sites that match given list of catalog ids.


/v1/sites

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/sites?catalogIds="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SitesApi;

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

public class SitesApiExample {

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

        SitesApi apiInstance = new SitesApi();
        array[String] catalogIds = ; // array[String] | List of catalog identifiers
        try {
            SiteListData result = apiInstance.getSitesByCatalogs1(catalogIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SitesApi#getSitesByCatalogs1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SitesApi;

public class SitesApiExample {

    public static void main(String[] args) {
        SitesApi apiInstance = new SitesApi();
        array[String] catalogIds = ; // array[String] | List of catalog identifiers
        try {
            SiteListData result = apiInstance.getSitesByCatalogs1(catalogIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SitesApi#getSitesByCatalogs1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
array[String] *catalogIds = ; // List of catalog identifiers

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

// Gets sites for catalogs.
[apiInstance getSitesByCatalogs1With:catalogIds
              completionHandler: ^(SiteListData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.SitesApi()
var catalogIds = ; // {{array[String]}} List of catalog identifiers

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

namespace Example
{
    public class getSitesByCatalogs1Example
    {
        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 SitesApi();
            var catalogIds = new array[String](); // array[String] | List of catalog identifiers

            try
            {
                // Gets sites for catalogs.
                SiteListData result = apiInstance.getSitesByCatalogs1(catalogIds);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SitesApi.getSitesByCatalogs1: " + 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\ApiSitesApi();
$catalogIds = ; // array[String] | List of catalog identifiers

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

# 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::SitesApi->new();
my $catalogIds = []; # array[String] | List of catalog identifiers

eval { 
    my $result = $api_instance->getSitesByCatalogs1(catalogIds => $catalogIds);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SitesApi->getSitesByCatalogs1: $@\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.SitesApi()
catalogIds =  # array[String] | List of catalog identifiers

try: 
    # Gets sites for catalogs.
    api_response = api_instance.get_sites_by_catalogs1(catalogIds)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SitesApi->getSitesByCatalogs1: %s\n" % e)

Parameters

Query parameters
Name Description
catalogIds*
array[String]
List of catalog identifiers
Required

Responses

Status: 200 - List of all sites for the given list of catalog ids, never null

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


searchSitesByCatalogs

Gets sites for catalogs by ids.

Retrieves a list of available sites that match given list of catalog ids by posting the catalogIds in the request body.


/v1/sites/catalogs

Usage and SDK Samples

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

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

public class SitesApiExample {

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

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

public class SitesApiExample {

    public static void main(String[] args) {
        SitesApi apiInstance = new SitesApi();
        CatalogDataList body = ; // CatalogDataList | 
        try {
            SiteListData result = apiInstance.searchSitesByCatalogs(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SitesApi#searchSitesByCatalogs");
            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"];
CatalogDataList *body = ; // 

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

// Gets sites for catalogs by ids.
[apiInstance searchSitesByCatalogsWith:body
              completionHandler: ^(SiteListData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.SitesApi()
var body = ; // {{CatalogDataList}} 

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

namespace Example
{
    public class searchSitesByCatalogsExample
    {
        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 SitesApi();
            var body = new CatalogDataList(); // CatalogDataList | 

            try
            {
                // Gets sites for catalogs by ids.
                SiteListData result = apiInstance.searchSitesByCatalogs(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SitesApi.searchSitesByCatalogs: " + 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\ApiSitesApi();
$body = ; // CatalogDataList | 

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

# 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::SitesApi->new();
my $body = WWW::SwaggerClient::Object::CatalogDataList->new(); # CatalogDataList | 

eval { 
    my $result = $api_instance->searchSitesByCatalogs(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SitesApi->searchSitesByCatalogs: $@\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.SitesApi()
body =  # CatalogDataList | 

try: 
    # Gets sites for catalogs by ids.
    api_response = api_instance.search_sites_by_catalogs(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SitesApi->searchSitesByCatalogs: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - List of all sites for the given list of catalog ids, never null

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


Types

getAllComponentTypesByCategory1

Gets all component types by category.

Finds all CMS component types filtered by a given category.


/v1/types

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/types?category=&code=&mode=&readOnly="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TypesApi;

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

public class TypesApiExample {

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

        TypesApi apiInstance = new TypesApi();
        String category = category_example; // String | The component type category of the types to be returned.
        String code = code_example; // String | Component type code
        String mode = mode_example; // String | The mode of the structure type
        String readOnly = readOnly_example; // String | Read only mode for attributes
        try {
            ComponentTypeListData result = apiInstance.getAllComponentTypesByCategory1(category, code, mode, readOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesApi#getAllComponentTypesByCategory1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TypesApi;

public class TypesApiExample {

    public static void main(String[] args) {
        TypesApi apiInstance = new TypesApi();
        String category = category_example; // String | The component type category of the types to be returned.
        String code = code_example; // String | Component type code
        String mode = mode_example; // String | The mode of the structure type
        String readOnly = readOnly_example; // String | Read only mode for attributes
        try {
            ComponentTypeListData result = apiInstance.getAllComponentTypesByCategory1(category, code, mode, readOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesApi#getAllComponentTypesByCategory1");
            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 *category = category_example; // The component type category of the types to be returned.
String *code = code_example; // Component type code
String *mode = mode_example; // The mode of the structure type
String *readOnly = readOnly_example; // Read only mode for attributes (optional) (default to false)

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

// Gets all component types by category.
[apiInstance getAllComponentTypesByCategory1With:category
    code:code
    mode:mode
    readOnly:readOnly
              completionHandler: ^(ComponentTypeListData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.TypesApi()
var category = category_example; // {{String}} The component type category of the types to be returned.
var code = code_example; // {{String}} Component type code
var mode = mode_example; // {{String}} The mode of the structure type
var opts = { 
  'readOnly': readOnly_example // {{String}} Read only mode for attributes
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllComponentTypesByCategory1(category, code, mode, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllComponentTypesByCategory1Example
    {
        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 TypesApi();
            var category = category_example;  // String | The component type category of the types to be returned.
            var code = code_example;  // String | Component type code
            var mode = mode_example;  // String | The mode of the structure type
            var readOnly = readOnly_example;  // String | Read only mode for attributes (optional)  (default to false)

            try
            {
                // Gets all component types by category.
                ComponentTypeListData result = apiInstance.getAllComponentTypesByCategory1(category, code, mode, readOnly);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TypesApi.getAllComponentTypesByCategory1: " + 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\ApiTypesApi();
$category = category_example; // String | The component type category of the types to be returned.
$code = code_example; // String | Component type code
$mode = mode_example; // String | The mode of the structure type
$readOnly = readOnly_example; // String | Read only mode for attributes

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

# 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::TypesApi->new();
my $category = category_example; # String | The component type category of the types to be returned.
my $code = code_example; # String | Component type code
my $mode = mode_example; # String | The mode of the structure type
my $readOnly = readOnly_example; # String | Read only mode for attributes

eval { 
    my $result = $api_instance->getAllComponentTypesByCategory1(category => $category, code => $code, mode => $mode, readOnly => $readOnly);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TypesApi->getAllComponentTypesByCategory1: $@\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.TypesApi()
category = category_example # String | The component type category of the types to be returned.
code = code_example # String | Component type code
mode = mode_example # String | The mode of the structure type
readOnly = readOnly_example # String | Read only mode for attributes (optional) (default to false)

try: 
    # Gets all component types by category.
    api_response = api_instance.get_all_component_types_by_category1(category, code, mode, readOnly=readOnly)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TypesApi->getAllComponentTypesByCategory1: %s\n" % e)

Parameters

Query parameters
Name Description
category*
String
The component type category of the types to be returned.
Required
code*
String
Component type code
Required
mode*
String
The mode of the structure type
Required
readOnly
String
Read only mode for attributes

Responses

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

Status: 400 - When the code provided does not match any existing type (ComponentTypeNotFoundException).

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getComponentTypeByCode

Gets component type by code.

Retrieves a specific instance of the CMS component type for a given code.


/v1/types/{code}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/types/{code}?readOnly="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TypesApi;

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

public class TypesApiExample {

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

        TypesApi apiInstance = new TypesApi();
        String code = code_example; // String | Component type code
        String readOnly = readOnly_example; // String | Read only mode for attributes
        try {
            ComponentTypeData result = apiInstance.getComponentTypeByCode(code, readOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesApi#getComponentTypeByCode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TypesApi;

public class TypesApiExample {

    public static void main(String[] args) {
        TypesApi apiInstance = new TypesApi();
        String code = code_example; // String | Component type code
        String readOnly = readOnly_example; // String | Read only mode for attributes
        try {
            ComponentTypeData result = apiInstance.getComponentTypeByCode(code, readOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesApi#getComponentTypeByCode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *code = code_example; // Component type code
String *readOnly = readOnly_example; // Read only mode for attributes (optional) (default to false)

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

// Gets component type by code.
[apiInstance getComponentTypeByCodeWith:code
    readOnly:readOnly
              completionHandler: ^(ComponentTypeData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.TypesApi()
var code = code_example; // {{String}} Component type code
var opts = { 
  'readOnly': readOnly_example // {{String}} Read only mode for attributes
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getComponentTypeByCode(code, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getComponentTypeByCodeExample
    {
        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 TypesApi();
            var code = code_example;  // String | Component type code
            var readOnly = readOnly_example;  // String | Read only mode for attributes (optional)  (default to false)

            try
            {
                // Gets component type by code.
                ComponentTypeData result = apiInstance.getComponentTypeByCode(code, readOnly);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TypesApi.getComponentTypeByCode: " + 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\ApiTypesApi();
$code = code_example; // String | Component type code
$readOnly = readOnly_example; // String | Read only mode for attributes

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

# 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::TypesApi->new();
my $code = code_example; # String | Component type code
my $readOnly = readOnly_example; # String | Read only mode for attributes

eval { 
    my $result = $api_instance->getComponentTypeByCode(code => $code, readOnly => $readOnly);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TypesApi->getComponentTypeByCode: $@\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.TypesApi()
code = code_example # String | Component type code
readOnly = readOnly_example # String | Read only mode for attributes (optional) (default to false)

try: 
    # Gets component type by code.
    api_response = api_instance.get_component_type_by_code(code, readOnly=readOnly)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TypesApi->getComponentTypeByCode: %s\n" % e)

Parameters

Path parameters
Name Description
code*
String
Component type code
Required
Query parameters
Name Description
readOnly
String
Read only mode for attributes

Responses

Status: 200 - DTO which serves as a wrapper object that contains a ComponentTypeData DTO

Status: 400 - When the code provided does not match any existing type(ComponentTypeNotFoundException).

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


UserGroups

getUserGroupById

Gets user group by id.

Retrieves a specific user group instance that matches the given id.


/v1/usergroups/{userGroupId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/usergroups/{userGroupId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserGroupsApi;

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

public class UserGroupsApiExample {

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

        UserGroupsApi apiInstance = new UserGroupsApi();
        String userGroupId = userGroupId_example; // String | The unique identifier of the user group
        try {
            UserGroup result = apiInstance.getUserGroupById(userGroupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserGroupsApi#getUserGroupById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserGroupsApi;

public class UserGroupsApiExample {

    public static void main(String[] args) {
        UserGroupsApi apiInstance = new UserGroupsApi();
        String userGroupId = userGroupId_example; // String | The unique identifier of the user group
        try {
            UserGroup result = apiInstance.getUserGroupById(userGroupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserGroupsApi#getUserGroupById");
            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 *userGroupId = userGroupId_example; // The unique identifier of the user group

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

// Gets user group by id.
[apiInstance getUserGroupByIdWith:userGroupId
              completionHandler: ^(UserGroup output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.UserGroupsApi()
var userGroupId = userGroupId_example; // {{String}} The unique identifier of the user group

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

namespace Example
{
    public class getUserGroupByIdExample
    {
        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 UserGroupsApi();
            var userGroupId = userGroupId_example;  // String | The unique identifier of the user group

            try
            {
                // Gets user group by id.
                UserGroup result = apiInstance.getUserGroupById(userGroupId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserGroupsApi.getUserGroupById: " + 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\ApiUserGroupsApi();
$userGroupId = userGroupId_example; // String | The unique identifier of the user group

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

# 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::UserGroupsApi->new();
my $userGroupId = userGroupId_example; # String | The unique identifier of the user group

eval { 
    my $result = $api_instance->getUserGroupById(userGroupId => $userGroupId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserGroupsApi->getUserGroupById: $@\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.UserGroupsApi()
userGroupId = userGroupId_example # String | The unique identifier of the user group

try: 
    # Gets user group by id.
    api_response = api_instance.get_user_group_by_id(userGroupId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserGroupsApi->getUserGroupById: %s\n" % e)

Parameters

Path parameters
Name Description
userGroupId*
String
The unique identifier of the user group
Required

Responses

Status: 200 - UserGroupWsDTO

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

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getUserGroupsByText

Finds user group by text.

Retrieves a list of available user groups using a free text search field.


/v1/usergroups

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/usergroups?currentPage=&mask=&pageSize=&pageableInfo=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserGroupsApi;

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

public class UserGroupsApiExample {

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

        UserGroupsApi apiInstance = new UserGroupsApi();
        String pageSize = pageSize_example; // String | The maximum number of elements in the result list.
        Pageable pageableInfo = ; // Pageable | PageableWsDTO
        String currentPage = currentPage_example; // String | The requested page number
        String mask = mask_example; // String | The string value on which products will be filtered
        String sort = sort_example; // String | The string field the results will be sorted with
        try {
            UserGroupList result = apiInstance.getUserGroupsByText(pageSize, pageableInfo, currentPage, mask, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserGroupsApi#getUserGroupsByText");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserGroupsApi;

public class UserGroupsApiExample {

    public static void main(String[] args) {
        UserGroupsApi apiInstance = new UserGroupsApi();
        String pageSize = pageSize_example; // String | The maximum number of elements in the result list.
        Pageable pageableInfo = ; // Pageable | PageableWsDTO
        String currentPage = currentPage_example; // String | The requested page number
        String mask = mask_example; // String | The string value on which products will be filtered
        String sort = sort_example; // String | The string field the results will be sorted with
        try {
            UserGroupList result = apiInstance.getUserGroupsByText(pageSize, pageableInfo, currentPage, mask, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserGroupsApi#getUserGroupsByText");
            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 *pageSize = pageSize_example; // The maximum number of elements in the result list.
Pageable *pageableInfo = ; // PageableWsDTO
String *currentPage = currentPage_example; // The requested page number (optional)
String *mask = mask_example; // The string value on which products will be filtered (optional)
String *sort = sort_example; // The string field the results will be sorted with (optional)

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

// Finds user group by text.
[apiInstance getUserGroupsByTextWith:pageSize
    pageableInfo:pageableInfo
    currentPage:currentPage
    mask:mask
    sort:sort
              completionHandler: ^(UserGroupList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.UserGroupsApi()
var pageSize = pageSize_example; // {{String}} The maximum number of elements in the result list.
var pageableInfo = ; // {{Pageable}} PageableWsDTO
var opts = { 
  'currentPage': currentPage_example, // {{String}} The requested page number
  'mask': mask_example, // {{String}} The string value on which products will be filtered
  '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.getUserGroupsByText(pageSize, pageableInfo, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getUserGroupsByTextExample
    {
        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 UserGroupsApi();
            var pageSize = pageSize_example;  // String | The maximum number of elements in the result list.
            var pageableInfo = new Pageable(); // Pageable | PageableWsDTO
            var currentPage = currentPage_example;  // String | The requested page number (optional) 
            var mask = mask_example;  // String | The string value on which products will be filtered (optional) 
            var sort = sort_example;  // String | The string field the results will be sorted with (optional) 

            try
            {
                // Finds user group by text.
                UserGroupList result = apiInstance.getUserGroupsByText(pageSize, pageableInfo, currentPage, mask, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserGroupsApi.getUserGroupsByText: " + 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\ApiUserGroupsApi();
$pageSize = pageSize_example; // String | The maximum number of elements in the result list.
$pageableInfo = ; // Pageable | PageableWsDTO
$currentPage = currentPage_example; // String | The requested page number
$mask = mask_example; // String | The string value on which products will be filtered
$sort = sort_example; // String | The string field the results will be sorted with

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

# 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::UserGroupsApi->new();
my $pageSize = pageSize_example; # String | The maximum number of elements in the result list.
my $pageableInfo = ; # Pageable | PageableWsDTO
my $currentPage = currentPage_example; # String | The requested page number
my $mask = mask_example; # String | The string value on which products will be filtered
my $sort = sort_example; # String | The string field the results will be sorted with

eval { 
    my $result = $api_instance->getUserGroupsByText(pageSize => $pageSize, pageableInfo => $pageableInfo, currentPage => $currentPage, mask => $mask, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserGroupsApi->getUserGroupsByText: $@\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.UserGroupsApi()
pageSize = pageSize_example # String | The maximum number of elements in the result list.
pageableInfo =  # Pageable | PageableWsDTO
currentPage = currentPage_example # String | The requested page number (optional)
mask = mask_example # String | The string value on which products will be filtered (optional)
sort = sort_example # String | The string field the results will be sorted with (optional)

try: 
    # Finds user group by text.
    api_response = api_instance.get_user_groups_by_text(pageSize, pageableInfo, currentPage=currentPage, mask=mask, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserGroupsApi->getUserGroupsByText: %s\n" % e)

Parameters

Query parameters
Name Description
currentPage
String
The requested page number
mask
String
The string value on which products will be filtered
pageSize*
String
The maximum number of elements in the result list.
Required
pageableInfo*
Pageable
PageableWsDTO
Required
sort
String
The string field the results will be sorted with

Responses

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

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


Users

getUserDataById

Gets user by id.

Retrieves a specific user instance that matches given id.


/v1/users/{userId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/users/{userId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

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

        UsersApi apiInstance = new UsersApi();
        String userId = userId_example; // String | The unique identifier of the user
        try {
            UserData result = apiInstance.getUserDataById(userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUserDataById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String userId = userId_example; // String | The unique identifier of the user
        try {
            UserData result = apiInstance.getUserDataById(userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUserDataById");
            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 *userId = userId_example; // The unique identifier of the user

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

// Gets user by id.
[apiInstance getUserDataByIdWith:userId
              completionHandler: ^(UserData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.UsersApi()
var userId = userId_example; // {{String}} The unique identifier of the user

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

namespace Example
{
    public class getUserDataByIdExample
    {
        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 UsersApi();
            var userId = userId_example;  // String | The unique identifier of the user

            try
            {
                // Gets user by id.
                UserData result = apiInstance.getUserDataById(userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.getUserDataById: " + 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\ApiUsersApi();
$userId = userId_example; // String | The unique identifier of the user

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

# 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::UsersApi->new();
my $userId = userId_example; # String | The unique identifier of the user

eval { 
    my $result = $api_instance->getUserDataById(userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->getUserDataById: $@\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.UsersApi()
userId = userId_example # String | The unique identifier of the user

try: 
    # Gets user by id.
    api_response = api_instance.get_user_data_by_id(userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->getUserDataById: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
The unique identifier of the user
Required

Responses

Status: 200 - UserDataInfo

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

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


Versions

createVersion

Creates a CMSVersion for an item.

Generates a new instance of the CMSVersion for the item identified by its itemUUID.


/v1/sites/{siteId}/cmsitems/{itemUUID}/versions

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/cmswebservices/v1/sites/{siteId}/cmsitems/{itemUUID}/versions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VersionsApi;

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

public class VersionsApiExample {

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

        VersionsApi apiInstance = new VersionsApi();
        CMSVersion body = ; // CMSVersion | 
        String itemUUID = itemUUID_example; // String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
        String siteId = siteId_example; // String | The site identifier
        try {
            CMSVersion result = apiInstance.createVersion(body, itemUUID, siteId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VersionsApi#createVersion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VersionsApi;

public class VersionsApiExample {

    public static void main(String[] args) {
        VersionsApi apiInstance = new VersionsApi();
        CMSVersion body = ; // CMSVersion | 
        String itemUUID = itemUUID_example; // String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
        String siteId = siteId_example; // String | The site identifier
        try {
            CMSVersion result = apiInstance.createVersion(body, itemUUID, siteId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VersionsApi#createVersion");
            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"];
CMSVersion *body = ; // 
String *itemUUID = itemUUID_example; // The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
String *siteId = siteId_example; // The site identifier

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

// Creates a CMSVersion for an item.
[apiInstance createVersionWith:body
    itemUUID:itemUUID
    siteId:siteId
              completionHandler: ^(CMSVersion output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.VersionsApi()
var body = ; // {{CMSVersion}} 
var itemUUID = itemUUID_example; // {{String}} The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
var siteId = siteId_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.createVersion(bodyitemUUIDsiteId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createVersionExample
    {
        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 VersionsApi();
            var body = new CMSVersion(); // CMSVersion | 
            var itemUUID = itemUUID_example;  // String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
            var siteId = siteId_example;  // String | The site identifier

            try
            {
                // Creates a CMSVersion for an item.
                CMSVersion result = apiInstance.createVersion(body, itemUUID, siteId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VersionsApi.createVersion: " + 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\ApiVersionsApi();
$body = ; // CMSVersion | 
$itemUUID = itemUUID_example; // String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
$siteId = siteId_example; // String | The site identifier

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

# 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::VersionsApi->new();
my $body = WWW::SwaggerClient::Object::CMSVersion->new(); # CMSVersion | 
my $itemUUID = itemUUID_example; # String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
my $siteId = siteId_example; # String | The site identifier

eval { 
    my $result = $api_instance->createVersion(body => $body, itemUUID => $itemUUID, siteId => $siteId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VersionsApi->createVersion: $@\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.VersionsApi()
body =  # CMSVersion | 
itemUUID = itemUUID_example # String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
siteId = siteId_example # String | The site identifier

try: 
    # Creates a CMSVersion for an item.
    api_response = api_instance.create_version(body, itemUUID, siteId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VersionsApi->createVersion: %s\n" % e)

Parameters

Path parameters
Name Description
itemUUID*
String
The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
Required
siteId*
String
The site identifier
Required
Body parameters
Name Description
body *

Responses

Status: 201 - The dto containing version info.

Status: 400 - If there is any validation error (WebserviceValidationException).

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


doRollbackVersion

Rolls back an item to a specific CMSVersion.

Sets a CMSversion of the item identified by its itemUUID to a previously saved CMSVersion.


/v1/sites/{siteId}/cmsitems/{itemUUID}/versions/{versionId}/rollbacks

Usage and SDK Samples

curl -X POST\
\
\
"http://localhost:9001/cmswebservices/v1/sites/{siteId}/cmsitems/{itemUUID}/versions/{versionId}/rollbacks"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VersionsApi;

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

public class VersionsApiExample {

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

        VersionsApi apiInstance = new VersionsApi();
        String itemUUID = itemUUID_example; // String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The uid of the cms version.
        try {
            apiInstance.doRollbackVersion(itemUUID, siteId, versionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling VersionsApi#doRollbackVersion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VersionsApi;

public class VersionsApiExample {

    public static void main(String[] args) {
        VersionsApi apiInstance = new VersionsApi();
        String itemUUID = itemUUID_example; // String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The uid of the cms version.
        try {
            apiInstance.doRollbackVersion(itemUUID, siteId, versionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling VersionsApi#doRollbackVersion");
            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 *itemUUID = itemUUID_example; // The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
String *siteId = siteId_example; // The site identifier
String *versionId = versionId_example; // The uid of the cms version.

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

// Rolls back an item to a specific CMSVersion.
[apiInstance doRollbackVersionWith:itemUUID
    siteId:siteId
    versionId:versionId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.VersionsApi()
var itemUUID = itemUUID_example; // {{String}} The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
var siteId = siteId_example; // {{String}} The site identifier
var versionId = versionId_example; // {{String}} The uid of the cms version.

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

namespace Example
{
    public class doRollbackVersionExample
    {
        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 VersionsApi();
            var itemUUID = itemUUID_example;  // String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
            var siteId = siteId_example;  // String | The site identifier
            var versionId = versionId_example;  // String | The uid of the cms version.

            try
            {
                // Rolls back an item to a specific CMSVersion.
                apiInstance.doRollbackVersion(itemUUID, siteId, versionId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VersionsApi.doRollbackVersion: " + 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\ApiVersionsApi();
$itemUUID = itemUUID_example; // String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
$siteId = siteId_example; // String | The site identifier
$versionId = versionId_example; // String | The uid of the cms version.

try {
    $api_instance->doRollbackVersion($itemUUID, $siteId, $versionId);
} catch (Exception $e) {
    echo 'Exception when calling VersionsApi->doRollbackVersion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VersionsApi;

# 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::VersionsApi->new();
my $itemUUID = itemUUID_example; # String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
my $siteId = siteId_example; # String | The site identifier
my $versionId = versionId_example; # String | The uid of the cms version.

eval { 
    $api_instance->doRollbackVersion(itemUUID => $itemUUID, siteId => $siteId, versionId => $versionId);
};
if ($@) {
    warn "Exception when calling VersionsApi->doRollbackVersion: $@\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.VersionsApi()
itemUUID = itemUUID_example # String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
siteId = siteId_example # String | The site identifier
versionId = versionId_example # String | The uid of the cms version.

try: 
    # Rolls back an item to a specific CMSVersion.
    api_instance.do_rollback_version(itemUUID, siteId, versionId)
except ApiException as e:
    print("Exception when calling VersionsApi->doRollbackVersion: %s\n" % e)

Parameters

Path parameters
Name Description
itemUUID*
String
The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
Required
siteId*
String
The site identifier
Required
versionId*
String
The uid of the cms version.
Required

Responses

Status: 204 - No Content

Status: 400 - If there is any validation error (WebserviceValidationException).

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getVersion

Gets a specific version for an item.

Retrieves a CMSVersion identified by its uid and for the item identified by its itemUUID.


/v1/sites/{siteId}/cmsitems/{itemUUID}/versions/{versionId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/sites/{siteId}/cmsitems/{itemUUID}/versions/{versionId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VersionsApi;

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

public class VersionsApiExample {

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

        VersionsApi apiInstance = new VersionsApi();
        String itemUUID = itemUUID_example; // String | The uuid of the item
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The uid of the cms version.
        try {
            CMSVersion result = apiInstance.getVersion(itemUUID, siteId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VersionsApi#getVersion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VersionsApi;

public class VersionsApiExample {

    public static void main(String[] args) {
        VersionsApi apiInstance = new VersionsApi();
        String itemUUID = itemUUID_example; // String | The uuid of the item
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The uid of the cms version.
        try {
            CMSVersion result = apiInstance.getVersion(itemUUID, siteId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VersionsApi#getVersion");
            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 *itemUUID = itemUUID_example; // The uuid of the item
String *siteId = siteId_example; // The site identifier
String *versionId = versionId_example; // The uid of the cms version.

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

// Gets a specific version for an item.
[apiInstance getVersionWith:itemUUID
    siteId:siteId
    versionId:versionId
              completionHandler: ^(CMSVersion output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.VersionsApi()
var itemUUID = itemUUID_example; // {{String}} The uuid of the item
var siteId = siteId_example; // {{String}} The site identifier
var versionId = versionId_example; // {{String}} The uid of the cms version.

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

namespace Example
{
    public class getVersionExample
    {
        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 VersionsApi();
            var itemUUID = itemUUID_example;  // String | The uuid of the item
            var siteId = siteId_example;  // String | The site identifier
            var versionId = versionId_example;  // String | The uid of the cms version.

            try
            {
                // Gets a specific version for an item.
                CMSVersion result = apiInstance.getVersion(itemUUID, siteId, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VersionsApi.getVersion: " + 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\ApiVersionsApi();
$itemUUID = itemUUID_example; // String | The uuid of the item
$siteId = siteId_example; // String | The site identifier
$versionId = versionId_example; // String | The uid of the cms version.

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

# 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::VersionsApi->new();
my $itemUUID = itemUUID_example; # String | The uuid of the item
my $siteId = siteId_example; # String | The site identifier
my $versionId = versionId_example; # String | The uid of the cms version.

eval { 
    my $result = $api_instance->getVersion(itemUUID => $itemUUID, siteId => $siteId, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VersionsApi->getVersion: $@\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.VersionsApi()
itemUUID = itemUUID_example # String | The uuid of the item
siteId = siteId_example # String | The site identifier
versionId = versionId_example # String | The uid of the cms version.

try: 
    # Gets a specific version for an item.
    api_response = api_instance.get_version(itemUUID, siteId, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VersionsApi->getVersion: %s\n" % e)

Parameters

Path parameters
Name Description
itemUUID*
String
The uuid of the item
Required
siteId*
String
The site identifier
Required
versionId*
String
The uid of the cms version.
Required

Responses

Status: 200 - The dto containing version info.

Status: 400 - When the version has not been found (CMSVersionNotFoundException)

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getVersionsForItem

Gets all versions for an item filtered by a mask.

Retrieves a list of available CMSVersions by a search mask for the item identified by its itemUUID.


/v1/sites/{siteId}/cmsitems/{itemUUID}/versions

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/sites/{siteId}/cmsitems/{itemUUID}/versions?currentPage=&mask=&pageSize="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VersionsApi;

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

public class VersionsApiExample {

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

        VersionsApi apiInstance = new VersionsApi();
        String itemUUID = itemUUID_example; // String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
        String siteId = siteId_example; // String | The site identifier
        String currentPage = currentPage_example; // String | The current result page requested
        String mask = mask_example; // String | Search mask applied to the LABEL field only. Uses partial matching.
        String pageSize = pageSize_example; // String | Page size for paging
        try {
            CMSVersionList result = apiInstance.getVersionsForItem(itemUUID, siteId, currentPage, mask, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VersionsApi#getVersionsForItem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VersionsApi;

public class VersionsApiExample {

    public static void main(String[] args) {
        VersionsApi apiInstance = new VersionsApi();
        String itemUUID = itemUUID_example; // String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
        String siteId = siteId_example; // String | The site identifier
        String currentPage = currentPage_example; // String | The current result page requested
        String mask = mask_example; // String | Search mask applied to the LABEL field only. Uses partial matching.
        String pageSize = pageSize_example; // String | Page size for paging
        try {
            CMSVersionList result = apiInstance.getVersionsForItem(itemUUID, siteId, currentPage, mask, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VersionsApi#getVersionsForItem");
            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 *itemUUID = itemUUID_example; // The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
String *siteId = siteId_example; // The site identifier
String *currentPage = currentPage_example; // The current result page requested (optional)
String *mask = mask_example; // Search mask applied to the LABEL field only. Uses partial matching. (optional)
String *pageSize = pageSize_example; // Page size for paging (optional)

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

// Gets all versions for an item filtered by a mask.
[apiInstance getVersionsForItemWith:itemUUID
    siteId:siteId
    currentPage:currentPage
    mask:mask
    pageSize:pageSize
              completionHandler: ^(CMSVersionList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.VersionsApi()
var itemUUID = itemUUID_example; // {{String}} The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
var siteId = siteId_example; // {{String}} The site identifier
var opts = { 
  'currentPage': currentPage_example, // {{String}} The current result page requested
  'mask': mask_example, // {{String}} Search mask applied to the LABEL field only. Uses partial matching.
  'pageSize': pageSize_example // {{String}} Page size for paging
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVersionsForItem(itemUUID, siteId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVersionsForItemExample
    {
        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 VersionsApi();
            var itemUUID = itemUUID_example;  // String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
            var siteId = siteId_example;  // String | The site identifier
            var currentPage = currentPage_example;  // String | The current result page requested (optional) 
            var mask = mask_example;  // String | Search mask applied to the LABEL field only. Uses partial matching. (optional) 
            var pageSize = pageSize_example;  // String | Page size for paging (optional) 

            try
            {
                // Gets all versions for an item filtered by a mask.
                CMSVersionList result = apiInstance.getVersionsForItem(itemUUID, siteId, currentPage, mask, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VersionsApi.getVersionsForItem: " + 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\ApiVersionsApi();
$itemUUID = itemUUID_example; // String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
$siteId = siteId_example; // String | The site identifier
$currentPage = currentPage_example; // String | The current result page requested
$mask = mask_example; // String | Search mask applied to the LABEL field only. Uses partial matching.
$pageSize = pageSize_example; // String | Page size for paging

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

# 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::VersionsApi->new();
my $itemUUID = itemUUID_example; # String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
my $siteId = siteId_example; # String | The site identifier
my $currentPage = currentPage_example; # String | The current result page requested
my $mask = mask_example; # String | Search mask applied to the LABEL field only. Uses partial matching.
my $pageSize = pageSize_example; # String | Page size for paging

eval { 
    my $result = $api_instance->getVersionsForItem(itemUUID => $itemUUID, siteId => $siteId, currentPage => $currentPage, mask => $mask, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VersionsApi->getVersionsForItem: $@\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.VersionsApi()
itemUUID = itemUUID_example # String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
siteId = siteId_example # String | The site identifier
currentPage = currentPage_example # String | The current result page requested (optional)
mask = mask_example # String | Search mask applied to the LABEL field only. Uses partial matching. (optional)
pageSize = pageSize_example # String | Page size for paging (optional)

try: 
    # Gets all versions for an item filtered by a mask.
    api_response = api_instance.get_versions_for_item(itemUUID, siteId, currentPage=currentPage, mask=mask, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VersionsApi->getVersionsForItem: %s\n" % e)

Parameters

Path parameters
Name Description
itemUUID*
String
The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
Required
siteId*
String
The site identifier
Required
Query parameters
Name Description
currentPage
String
The current result page requested
mask
String
Search mask applied to the LABEL field only. Uses partial matching.
pageSize
String
Page size for paging

Responses

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

Status: 400 - When the item has not been found (CMSItemNotFoundException)

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


removeVersion

Deletes a CMSVersion for an item.

Removes a specific instance of the CMSVersion identified by its uid and for the item identified by its itemUUID.


/v1/sites/{siteId}/cmsitems/{itemUUID}/versions/{versionId}

Usage and SDK Samples

curl -X DELETE\
\
\
"http://localhost:9001/cmswebservices/v1/sites/{siteId}/cmsitems/{itemUUID}/versions/{versionId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VersionsApi;

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

public class VersionsApiExample {

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

        VersionsApi apiInstance = new VersionsApi();
        String itemUUID = itemUUID_example; // String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The uid of the cms version.
        try {
            apiInstance.removeVersion(itemUUID, siteId, versionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling VersionsApi#removeVersion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VersionsApi;

public class VersionsApiExample {

    public static void main(String[] args) {
        VersionsApi apiInstance = new VersionsApi();
        String itemUUID = itemUUID_example; // String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The uid of the cms version.
        try {
            apiInstance.removeVersion(itemUUID, siteId, versionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling VersionsApi#removeVersion");
            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 *itemUUID = itemUUID_example; // The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
String *siteId = siteId_example; // The site identifier
String *versionId = versionId_example; // The uid of the cms version.

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

// Deletes a CMSVersion for an item.
[apiInstance removeVersionWith:itemUUID
    siteId:siteId
    versionId:versionId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.VersionsApi()
var itemUUID = itemUUID_example; // {{String}} The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
var siteId = siteId_example; // {{String}} The site identifier
var versionId = versionId_example; // {{String}} The uid of the cms version.

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

namespace Example
{
    public class removeVersionExample
    {
        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 VersionsApi();
            var itemUUID = itemUUID_example;  // String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
            var siteId = siteId_example;  // String | The site identifier
            var versionId = versionId_example;  // String | The uid of the cms version.

            try
            {
                // Deletes a CMSVersion for an item.
                apiInstance.removeVersion(itemUUID, siteId, versionId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VersionsApi.removeVersion: " + 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\ApiVersionsApi();
$itemUUID = itemUUID_example; // String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
$siteId = siteId_example; // String | The site identifier
$versionId = versionId_example; // String | The uid of the cms version.

try {
    $api_instance->removeVersion($itemUUID, $siteId, $versionId);
} catch (Exception $e) {
    echo 'Exception when calling VersionsApi->removeVersion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VersionsApi;

# 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::VersionsApi->new();
my $itemUUID = itemUUID_example; # String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
my $siteId = siteId_example; # String | The site identifier
my $versionId = versionId_example; # String | The uid of the cms version.

eval { 
    $api_instance->removeVersion(itemUUID => $itemUUID, siteId => $siteId, versionId => $versionId);
};
if ($@) {
    warn "Exception when calling VersionsApi->removeVersion: $@\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.VersionsApi()
itemUUID = itemUUID_example # String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
siteId = siteId_example # String | The site identifier
versionId = versionId_example # String | The uid of the cms version.

try: 
    # Deletes a CMSVersion for an item.
    api_instance.remove_version(itemUUID, siteId, versionId)
except ApiException as e:
    print("Exception when calling VersionsApi->removeVersion: %s\n" % e)

Parameters

Path parameters
Name Description
itemUUID*
String
The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
Required
siteId*
String
The site identifier
Required
versionId*
String
The uid of the cms version.
Required

Responses

Status: 204 - No Content

Status: 400 - If there is any validation error (WebserviceValidationException).

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


replaceVersion

Updates a CMSVersion for an item.

Replaces an existing CMSVersion identified by its uid for the item identified by its itemUUID.


/v1/sites/{siteId}/cmsitems/{itemUUID}/versions/{versionId}

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/cmswebservices/v1/sites/{siteId}/cmsitems/{itemUUID}/versions/{versionId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VersionsApi;

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

public class VersionsApiExample {

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

        VersionsApi apiInstance = new VersionsApi();
        CMSVersion body = ; // CMSVersion | 
        String itemUUID = itemUUID_example; // String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The uid of the cms version.
        try {
            CMSVersion result = apiInstance.replaceVersion(body, itemUUID, siteId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VersionsApi#replaceVersion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VersionsApi;

public class VersionsApiExample {

    public static void main(String[] args) {
        VersionsApi apiInstance = new VersionsApi();
        CMSVersion body = ; // CMSVersion | 
        String itemUUID = itemUUID_example; // String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
        String siteId = siteId_example; // String | The site identifier
        String versionId = versionId_example; // String | The uid of the cms version.
        try {
            CMSVersion result = apiInstance.replaceVersion(body, itemUUID, siteId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VersionsApi#replaceVersion");
            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"];
CMSVersion *body = ; // 
String *itemUUID = itemUUID_example; // The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
String *siteId = siteId_example; // The site identifier
String *versionId = versionId_example; // The uid of the cms version.

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

// Updates a CMSVersion for an item.
[apiInstance replaceVersionWith:body
    itemUUID:itemUUID
    siteId:siteId
    versionId:versionId
              completionHandler: ^(CMSVersion output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.VersionsApi()
var body = ; // {{CMSVersion}} 
var itemUUID = itemUUID_example; // {{String}} The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
var siteId = siteId_example; // {{String}} The site identifier
var versionId = versionId_example; // {{String}} The uid of the cms version.

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

namespace Example
{
    public class replaceVersionExample
    {
        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 VersionsApi();
            var body = new CMSVersion(); // CMSVersion | 
            var itemUUID = itemUUID_example;  // String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
            var siteId = siteId_example;  // String | The site identifier
            var versionId = versionId_example;  // String | The uid of the cms version.

            try
            {
                // Updates a CMSVersion for an item.
                CMSVersion result = apiInstance.replaceVersion(body, itemUUID, siteId, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VersionsApi.replaceVersion: " + 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\ApiVersionsApi();
$body = ; // CMSVersion | 
$itemUUID = itemUUID_example; // String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
$siteId = siteId_example; // String | The site identifier
$versionId = versionId_example; // String | The uid of the cms version.

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

# 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::VersionsApi->new();
my $body = WWW::SwaggerClient::Object::CMSVersion->new(); # CMSVersion | 
my $itemUUID = itemUUID_example; # String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
my $siteId = siteId_example; # String | The site identifier
my $versionId = versionId_example; # String | The uid of the cms version.

eval { 
    my $result = $api_instance->replaceVersion(body => $body, itemUUID => $itemUUID, siteId => $siteId, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VersionsApi->replaceVersion: $@\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.VersionsApi()
body =  # CMSVersion | 
itemUUID = itemUUID_example # String | The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
siteId = siteId_example # String | The site identifier
versionId = versionId_example # String | The uid of the cms version.

try: 
    # Updates a CMSVersion for an item.
    api_response = api_instance.replace_version(body, itemUUID, siteId, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VersionsApi->replaceVersion: %s\n" % e)

Parameters

Path parameters
Name Description
itemUUID*
String
The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
Required
siteId*
String
The site identifier
Required
versionId*
String
The uid of the cms version.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - The dto containing version info.

Status: 400 - If there is any validation error (WebserviceValidationException).

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


WorkflowActions

getActionComments

Gets workflow action comments.

Retrieves a list of available workflow action comments for a specific workflow item.


/v1/catalogs/{catalogId}/versions/{versionId}/workflows/{workflowCode}/actions/{actionCode}/comments

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/catalogs/{catalogId}/versions/{versionId}/workflows/{workflowCode}/actions/{actionCode}/comments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WorkflowActionsApi;

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

public class WorkflowActionsApiExample {

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

        WorkflowActionsApi apiInstance = new WorkflowActionsApi();
        String actionCode = actionCode_example; // String | The code of the workflow action
        String catalogId = catalogId_example; // String | The id of the catalog
        String versionId = versionId_example; // String | The version of the catalog
        String workflowCode = workflowCode_example; // String | The code of the workflow
        try {
            CMSCommentList result = apiInstance.getActionComments(actionCode, catalogId, versionId, workflowCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkflowActionsApi#getActionComments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WorkflowActionsApi;

public class WorkflowActionsApiExample {

    public static void main(String[] args) {
        WorkflowActionsApi apiInstance = new WorkflowActionsApi();
        String actionCode = actionCode_example; // String | The code of the workflow action
        String catalogId = catalogId_example; // String | The id of the catalog
        String versionId = versionId_example; // String | The version of the catalog
        String workflowCode = workflowCode_example; // String | The code of the workflow
        try {
            CMSCommentList result = apiInstance.getActionComments(actionCode, catalogId, versionId, workflowCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkflowActionsApi#getActionComments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *actionCode = actionCode_example; // The code of the workflow action
String *catalogId = catalogId_example; // The id of the catalog
String *versionId = versionId_example; // The version of the catalog
String *workflowCode = workflowCode_example; // The code of the workflow

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

// Gets workflow action comments.
[apiInstance getActionCommentsWith:actionCode
    catalogId:catalogId
    versionId:versionId
    workflowCode:workflowCode
              completionHandler: ^(CMSCommentList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.WorkflowActionsApi()
var actionCode = actionCode_example; // {{String}} The code of the workflow action
var catalogId = catalogId_example; // {{String}} The id of the catalog
var versionId = versionId_example; // {{String}} The version of the catalog
var workflowCode = workflowCode_example; // {{String}} The code of the workflow

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

namespace Example
{
    public class getActionCommentsExample
    {
        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 WorkflowActionsApi();
            var actionCode = actionCode_example;  // String | The code of the workflow action
            var catalogId = catalogId_example;  // String | The id of the catalog
            var versionId = versionId_example;  // String | The version of the catalog
            var workflowCode = workflowCode_example;  // String | The code of the workflow

            try
            {
                // Gets workflow action comments.
                CMSCommentList result = apiInstance.getActionComments(actionCode, catalogId, versionId, workflowCode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WorkflowActionsApi.getActionComments: " + 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\ApiWorkflowActionsApi();
$actionCode = actionCode_example; // String | The code of the workflow action
$catalogId = catalogId_example; // String | The id of the catalog
$versionId = versionId_example; // String | The version of the catalog
$workflowCode = workflowCode_example; // String | The code of the workflow

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

# 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::WorkflowActionsApi->new();
my $actionCode = actionCode_example; # String | The code of the workflow action
my $catalogId = catalogId_example; # String | The id of the catalog
my $versionId = versionId_example; # String | The version of the catalog
my $workflowCode = workflowCode_example; # String | The code of the workflow

eval { 
    my $result = $api_instance->getActionComments(actionCode => $actionCode, catalogId => $catalogId, versionId => $versionId, workflowCode => $workflowCode);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WorkflowActionsApi->getActionComments: $@\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.WorkflowActionsApi()
actionCode = actionCode_example # String | The code of the workflow action
catalogId = catalogId_example # String | The id of the catalog
versionId = versionId_example # String | The version of the catalog
workflowCode = workflowCode_example # String | The code of the workflow

try: 
    # Gets workflow action comments.
    api_response = api_instance.get_action_comments(actionCode, catalogId, versionId, workflowCode)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WorkflowActionsApi->getActionComments: %s\n" % e)

Parameters

Path parameters
Name Description
actionCode*
String
The code of the workflow action
Required
catalogId*
String
The id of the catalog
Required
versionId*
String
The version of the catalog
Required
workflowCode*
String
The code of the workflow
Required

Responses

Status: 200 - The dto containing the workflow action comments.

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - When no workflow or workflow action is found matching the given code (UnknownIdentifierException).


getActionsByWorkflowCode

Gets a list of actions.

Retrieves a list of available actions for a given workflow item, catalog and version ids.


/v1/catalogs/{catalogId}/versions/{versionId}/workflows/{workflowCode}/actions

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/catalogs/{catalogId}/versions/{versionId}/workflows/{workflowCode}/actions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WorkflowActionsApi;

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

public class WorkflowActionsApiExample {

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

        WorkflowActionsApi apiInstance = new WorkflowActionsApi();
        String catalogId = catalogId_example; // String | The id of the catalog
        String versionId = versionId_example; // String | The version of the catalog
        String workflowCode = workflowCode_example; // String | The code of the workflow
        try {
            CMSWorkflow result = apiInstance.getActionsByWorkflowCode(catalogId, versionId, workflowCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkflowActionsApi#getActionsByWorkflowCode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WorkflowActionsApi;

public class WorkflowActionsApiExample {

    public static void main(String[] args) {
        WorkflowActionsApi apiInstance = new WorkflowActionsApi();
        String catalogId = catalogId_example; // String | The id of the catalog
        String versionId = versionId_example; // String | The version of the catalog
        String workflowCode = workflowCode_example; // String | The code of the workflow
        try {
            CMSWorkflow result = apiInstance.getActionsByWorkflowCode(catalogId, versionId, workflowCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkflowActionsApi#getActionsByWorkflowCode");
            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 id of the catalog
String *versionId = versionId_example; // The version of the catalog
String *workflowCode = workflowCode_example; // The code of the workflow

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

// Gets a list of actions.
[apiInstance getActionsByWorkflowCodeWith:catalogId
    versionId:versionId
    workflowCode:workflowCode
              completionHandler: ^(CMSWorkflow output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.WorkflowActionsApi()
var catalogId = catalogId_example; // {{String}} The id of the catalog
var versionId = versionId_example; // {{String}} The version of the catalog
var workflowCode = workflowCode_example; // {{String}} The code of the workflow

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

namespace Example
{
    public class getActionsByWorkflowCodeExample
    {
        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 WorkflowActionsApi();
            var catalogId = catalogId_example;  // String | The id of the catalog
            var versionId = versionId_example;  // String | The version of the catalog
            var workflowCode = workflowCode_example;  // String | The code of the workflow

            try
            {
                // Gets a list of actions.
                CMSWorkflow result = apiInstance.getActionsByWorkflowCode(catalogId, versionId, workflowCode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WorkflowActionsApi.getActionsByWorkflowCode: " + 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\ApiWorkflowActionsApi();
$catalogId = catalogId_example; // String | The id of the catalog
$versionId = versionId_example; // String | The version of the catalog
$workflowCode = workflowCode_example; // String | The code of the workflow

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

# 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::WorkflowActionsApi->new();
my $catalogId = catalogId_example; # String | The id of the catalog
my $versionId = versionId_example; # String | The version of the catalog
my $workflowCode = workflowCode_example; # String | The code of the workflow

eval { 
    my $result = $api_instance->getActionsByWorkflowCode(catalogId => $catalogId, versionId => $versionId, workflowCode => $workflowCode);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WorkflowActionsApi->getActionsByWorkflowCode: $@\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.WorkflowActionsApi()
catalogId = catalogId_example # String | The id of the catalog
versionId = versionId_example # String | The version of the catalog
workflowCode = workflowCode_example # String | The code of the workflow

try: 
    # Gets a list of actions.
    api_response = api_instance.get_actions_by_workflow_code(catalogId, versionId, workflowCode)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WorkflowActionsApi->getActionsByWorkflowCode: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The id of the catalog
Required
versionId*
String
The version of the catalog
Required
workflowCode*
String
The code of the workflow
Required

Responses

Status: 200 - The dto containing the workflow items actions and decisions.

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - When no workflow is found matching the given code (UnknownIdentifierException).


WorkflowOperations

doPerfomActionOnWorkflow

Performs different operations on the workflow item.

Executes various actions, such as canceling a workflow, on the workflow item.


/v1/catalogs/{catalogId}/versions/{versionId}/workflows/{workflowId}/operations

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/cmswebservices/v1/catalogs/{catalogId}/versions/{versionId}/workflows/{workflowId}/operations"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WorkflowOperationsApi;

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

public class WorkflowOperationsApiExample {

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

        WorkflowOperationsApi apiInstance = new WorkflowOperationsApi();
        CMSWorkflowOperation body = ; // CMSWorkflowOperation | 
        String catalogId = catalogId_example; // String | The catalog identifier
        String versionId = versionId_example; // String | The catalog version identifier
        String workflowId = workflowId_example; // String | The code of the workflow
        try {
            CMSWorkflow result = apiInstance.doPerfomActionOnWorkflow(body, catalogId, versionId, workflowId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkflowOperationsApi#doPerfomActionOnWorkflow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WorkflowOperationsApi;

public class WorkflowOperationsApiExample {

    public static void main(String[] args) {
        WorkflowOperationsApi apiInstance = new WorkflowOperationsApi();
        CMSWorkflowOperation body = ; // CMSWorkflowOperation | 
        String catalogId = catalogId_example; // String | The catalog identifier
        String versionId = versionId_example; // String | The catalog version identifier
        String workflowId = workflowId_example; // String | The code of the workflow
        try {
            CMSWorkflow result = apiInstance.doPerfomActionOnWorkflow(body, catalogId, versionId, workflowId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkflowOperationsApi#doPerfomActionOnWorkflow");
            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"];
CMSWorkflowOperation *body = ; // 
String *catalogId = catalogId_example; // The catalog identifier
String *versionId = versionId_example; // The catalog version identifier
String *workflowId = workflowId_example; // The code of the workflow

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

// Performs different operations on the workflow item.
[apiInstance doPerfomActionOnWorkflowWith:body
    catalogId:catalogId
    versionId:versionId
    workflowId:workflowId
              completionHandler: ^(CMSWorkflow output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.WorkflowOperationsApi()
var body = ; // {{CMSWorkflowOperation}} 
var catalogId = catalogId_example; // {{String}} The catalog identifier
var versionId = versionId_example; // {{String}} The catalog version identifier
var workflowId = workflowId_example; // {{String}} The code of the workflow

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

namespace Example
{
    public class doPerfomActionOnWorkflowExample
    {
        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 WorkflowOperationsApi();
            var body = new CMSWorkflowOperation(); // CMSWorkflowOperation | 
            var catalogId = catalogId_example;  // String | The catalog identifier
            var versionId = versionId_example;  // String | The catalog version identifier
            var workflowId = workflowId_example;  // String | The code of the workflow

            try
            {
                // Performs different operations on the workflow item.
                CMSWorkflow result = apiInstance.doPerfomActionOnWorkflow(body, catalogId, versionId, workflowId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WorkflowOperationsApi.doPerfomActionOnWorkflow: " + 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\ApiWorkflowOperationsApi();
$body = ; // CMSWorkflowOperation | 
$catalogId = catalogId_example; // String | The catalog identifier
$versionId = versionId_example; // String | The catalog version identifier
$workflowId = workflowId_example; // String | The code of the workflow

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

# 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::WorkflowOperationsApi->new();
my $body = WWW::SwaggerClient::Object::CMSWorkflowOperation->new(); # CMSWorkflowOperation | 
my $catalogId = catalogId_example; # String | The catalog identifier
my $versionId = versionId_example; # String | The catalog version identifier
my $workflowId = workflowId_example; # String | The code of the workflow

eval { 
    my $result = $api_instance->doPerfomActionOnWorkflow(body => $body, catalogId => $catalogId, versionId => $versionId, workflowId => $workflowId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WorkflowOperationsApi->doPerfomActionOnWorkflow: $@\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.WorkflowOperationsApi()
body =  # CMSWorkflowOperation | 
catalogId = catalogId_example # String | The catalog identifier
versionId = versionId_example # String | The catalog version identifier
workflowId = workflowId_example # String | The code of the workflow

try: 
    # Performs different operations on the workflow item.
    api_response = api_instance.do_perfom_action_on_workflow(body, catalogId, versionId, workflowId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WorkflowOperationsApi->doPerfomActionOnWorkflow: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog identifier
Required
versionId*
String
The catalog version identifier
Required
workflowId*
String
The code of the workflow
Required
Body parameters
Name Description
body *

Responses

Status: 200 - The workflow 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)


WorkflowTemplates

getWorkflowTemplatesForCatalogVersion

Gets Workflow templates for catalog version.

Retrieves the list of available workflow templates for given catalogId and versionId.


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

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/catalogs/{catalogId}/versions/{versionId}/workflowtemplates"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WorkflowTemplatesApi;

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

public class WorkflowTemplatesApiExample {

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

        WorkflowTemplatesApi apiInstance = new WorkflowTemplatesApi();
        String catalogId = catalogId_example; // String | The catalog id
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            WorkflowTemplateList result = apiInstance.getWorkflowTemplatesForCatalogVersion(catalogId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkflowTemplatesApi#getWorkflowTemplatesForCatalogVersion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WorkflowTemplatesApi;

public class WorkflowTemplatesApiExample {

    public static void main(String[] args) {
        WorkflowTemplatesApi apiInstance = new WorkflowTemplatesApi();
        String catalogId = catalogId_example; // String | The catalog id
        String versionId = versionId_example; // String | The catalog version identifier
        try {
            WorkflowTemplateList result = apiInstance.getWorkflowTemplatesForCatalogVersion(catalogId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkflowTemplatesApi#getWorkflowTemplatesForCatalogVersion");
            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
String *versionId = versionId_example; // The catalog version identifier

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

// Gets Workflow templates for catalog version.
[apiInstance getWorkflowTemplatesForCatalogVersionWith:catalogId
    versionId:versionId
              completionHandler: ^(WorkflowTemplateList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.WorkflowTemplatesApi()
var catalogId = catalogId_example; // {{String}} The catalog id
var versionId = versionId_example; // {{String}} The catalog version identifier

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

namespace Example
{
    public class getWorkflowTemplatesForCatalogVersionExample
    {
        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 WorkflowTemplatesApi();
            var catalogId = catalogId_example;  // String | The catalog id
            var versionId = versionId_example;  // String | The catalog version identifier

            try
            {
                // Gets Workflow templates for catalog version.
                WorkflowTemplateList result = apiInstance.getWorkflowTemplatesForCatalogVersion(catalogId, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WorkflowTemplatesApi.getWorkflowTemplatesForCatalogVersion: " + 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\ApiWorkflowTemplatesApi();
$catalogId = catalogId_example; // String | The catalog id
$versionId = versionId_example; // String | The catalog version identifier

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

# 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::WorkflowTemplatesApi->new();
my $catalogId = catalogId_example; # String | The catalog id
my $versionId = versionId_example; # String | The catalog version identifier

eval { 
    my $result = $api_instance->getWorkflowTemplatesForCatalogVersion(catalogId => $catalogId, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WorkflowTemplatesApi->getWorkflowTemplatesForCatalogVersion: $@\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.WorkflowTemplatesApi()
catalogId = catalogId_example # String | The catalog id
versionId = versionId_example # String | The catalog version identifier

try: 
    # Gets Workflow templates for catalog version.
    api_response = api_instance.get_workflow_templates_for_catalog_version(catalogId, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WorkflowTemplatesApi->getWorkflowTemplatesForCatalogVersion: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The catalog id
Required
versionId*
String
The catalog version identifier
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


Workflows

doCreateWorkflow

Creates and start a new workflow.

Generates a workflow instance containing CmsItems. The workflow is automatically started upon generation.


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

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/cmswebservices/v1/catalogs/{catalogId}/versions/{versionId}/workflows"
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();
        CMSWorkflow body = ; // CMSWorkflow | 
        String catalogId = catalogId_example; // String | The id of the catalog
        String versionId = versionId_example; // String | The version of the catalog
        try {
            CMSWorkflow result = apiInstance.doCreateWorkflow(body, catalogId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkflowsApi#doCreateWorkflow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WorkflowsApi;

public class WorkflowsApiExample {

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

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

// Creates and start a new workflow.
[apiInstance doCreateWorkflowWith:body
    catalogId:catalogId
    versionId:versionId
              completionHandler: ^(CMSWorkflow output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.WorkflowsApi()
var body = ; // {{CMSWorkflow}} 
var catalogId = catalogId_example; // {{String}} The id of the catalog
var versionId = versionId_example; // {{String}} The version of the catalog

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

namespace Example
{
    public class doCreateWorkflowExample
    {
        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 body = new CMSWorkflow(); // CMSWorkflow | 
            var catalogId = catalogId_example;  // String | The id of the catalog
            var versionId = versionId_example;  // String | The version of the catalog

            try
            {
                // Creates and start a new workflow.
                CMSWorkflow result = apiInstance.doCreateWorkflow(body, catalogId, versionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WorkflowsApi.doCreateWorkflow: " + 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();
$body = ; // CMSWorkflow | 
$catalogId = catalogId_example; // String | The id of the catalog
$versionId = versionId_example; // String | The version of the catalog

try {
    $result = $api_instance->doCreateWorkflow($body, $catalogId, $versionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WorkflowsApi->doCreateWorkflow: ', $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 $body = WWW::SwaggerClient::Object::CMSWorkflow->new(); # CMSWorkflow | 
my $catalogId = catalogId_example; # String | The id of the catalog
my $versionId = versionId_example; # String | The version of the catalog

eval { 
    my $result = $api_instance->doCreateWorkflow(body => $body, catalogId => $catalogId, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WorkflowsApi->doCreateWorkflow: $@\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()
body =  # CMSWorkflow | 
catalogId = catalogId_example # String | The id of the catalog
versionId = versionId_example # String | The version of the catalog

try: 
    # Creates and start a new workflow.
    api_response = api_instance.do_create_workflow(body, catalogId, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WorkflowsApi->doCreateWorkflow: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The id of the catalog
Required
versionId*
String
The version of the catalog
Required
Body parameters
Name Description
body *

Responses

Status: 201 - The dto containing the workflow info.

Status: 400 - If there is any validation error (WebserviceValidationException).

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getAllWorkflowsForAttachments

Finds all workflows containing the given attachments.

Retrieves a list of available workflow instances that has the given CMSItem uuids as an attachment to the workflow.


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

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/catalogs/{catalogId}/versions/{versionId}/workflows?attachment=¤tPage=&pageSize=&pageableInfo=&sort=&statuses="
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 id of the catalog
        String currentPage = currentPage_example; // String | Catalog on which to search
        String pageSize = pageSize_example; // String | Page size for paging
        Pageable pageableInfo = ; // Pageable | Pageable DTO
        String versionId = versionId_example; // String | The version of the catalog
        String attachment = attachment_example; // String | The uuid of the CMSItem attached to the workflow
        String sort = sort_example; // String | The requested ordering for the search results.
        array[String] statuses = ; // array[String] | The list of workflow statues. When none provided, the default statuses are set to RUNNING and PAUSED. This will return all active workflows.
        try {
            CMSWorkflowList result = apiInstance.getAllWorkflowsForAttachments(catalogId, currentPage, pageSize, pageableInfo, versionId, attachment, sort, statuses);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkflowsApi#getAllWorkflowsForAttachments");
            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 id of the catalog
        String currentPage = currentPage_example; // String | Catalog on which to search
        String pageSize = pageSize_example; // String | Page size for paging
        Pageable pageableInfo = ; // Pageable | Pageable DTO
        String versionId = versionId_example; // String | The version of the catalog
        String attachment = attachment_example; // String | The uuid of the CMSItem attached to the workflow
        String sort = sort_example; // String | The requested ordering for the search results.
        array[String] statuses = ; // array[String] | The list of workflow statues. When none provided, the default statuses are set to RUNNING and PAUSED. This will return all active workflows.
        try {
            CMSWorkflowList result = apiInstance.getAllWorkflowsForAttachments(catalogId, currentPage, pageSize, pageableInfo, versionId, attachment, sort, statuses);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkflowsApi#getAllWorkflowsForAttachments");
            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 id of the catalog
String *currentPage = currentPage_example; // Catalog on which to search
String *pageSize = pageSize_example; // Page size for paging
Pageable *pageableInfo = ; // Pageable DTO
String *versionId = versionId_example; // The version of the catalog
String *attachment = attachment_example; // The uuid of the CMSItem attached to the workflow (optional)
String *sort = sort_example; // The requested ordering for the search results. (optional)
array[String] *statuses = ; // The list of workflow statues. When none provided, the default statuses are set to RUNNING and PAUSED. This will return all active workflows. (optional) (default to ["RUNNING","PAUSED"])

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

// Finds all workflows containing the given attachments.
[apiInstance getAllWorkflowsForAttachmentsWith:catalogId
    currentPage:currentPage
    pageSize:pageSize
    pageableInfo:pageableInfo
    versionId:versionId
    attachment:attachment
    sort:sort
    statuses:statuses
              completionHandler: ^(CMSWorkflowList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.WorkflowsApi()
var catalogId = catalogId_example; // {{String}} The id of the catalog
var currentPage = currentPage_example; // {{String}} Catalog on which to search
var pageSize = pageSize_example; // {{String}} Page size for paging
var pageableInfo = ; // {{Pageable}} Pageable DTO
var versionId = versionId_example; // {{String}} The version of the catalog
var opts = { 
  'attachment': attachment_example, // {{String}} The uuid of the CMSItem attached to the workflow
  'sort': sort_example, // {{String}} The requested ordering for the search results.
  'statuses':  // {{array[String]}} The list of workflow statues. When none provided, the default statuses are set to RUNNING and PAUSED. This will return all active workflows.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllWorkflowsForAttachments(catalogId, currentPage, 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 getAllWorkflowsForAttachmentsExample
    {
        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 id of the catalog
            var currentPage = currentPage_example;  // String | Catalog on which to search
            var pageSize = pageSize_example;  // String | Page size for paging
            var pageableInfo = new Pageable(); // Pageable | Pageable DTO
            var versionId = versionId_example;  // String | The version of the catalog
            var attachment = attachment_example;  // String | The uuid of the CMSItem attached to the workflow (optional) 
            var sort = sort_example;  // String | The requested ordering for the search results. (optional) 
            var statuses = new array[String](); // array[String] | The list of workflow statues. When none provided, the default statuses are set to RUNNING and PAUSED. This will return all active workflows. (optional)  (default to ["RUNNING","PAUSED"])

            try
            {
                // Finds all workflows containing the given attachments.
                CMSWorkflowList result = apiInstance.getAllWorkflowsForAttachments(catalogId, currentPage, pageSize, pageableInfo, versionId, attachment, sort, statuses);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WorkflowsApi.getAllWorkflowsForAttachments: " + 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 id of the catalog
$currentPage = currentPage_example; // String | Catalog on which to search
$pageSize = pageSize_example; // String | Page size for paging
$pageableInfo = ; // Pageable | Pageable DTO
$versionId = versionId_example; // String | The version of the catalog
$attachment = attachment_example; // String | The uuid of the CMSItem attached to the workflow
$sort = sort_example; // String | The requested ordering for the search results.
$statuses = ; // array[String] | The list of workflow statues. When none provided, the default statuses are set to RUNNING and PAUSED. This will return all active workflows.

try {
    $result = $api_instance->getAllWorkflowsForAttachments($catalogId, $currentPage, $pageSize, $pageableInfo, $versionId, $attachment, $sort, $statuses);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WorkflowsApi->getAllWorkflowsForAttachments: ', $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 id of the catalog
my $currentPage = currentPage_example; # String | Catalog on which to search
my $pageSize = pageSize_example; # String | Page size for paging
my $pageableInfo = ; # Pageable | Pageable DTO
my $versionId = versionId_example; # String | The version of the catalog
my $attachment = attachment_example; # String | The uuid of the CMSItem attached to the workflow
my $sort = sort_example; # String | The requested ordering for the search results.
my $statuses = []; # array[String] | The list of workflow statues. When none provided, the default statuses are set to RUNNING and PAUSED. This will return all active workflows.

eval { 
    my $result = $api_instance->getAllWorkflowsForAttachments(catalogId => $catalogId, currentPage => $currentPage, pageSize => $pageSize, pageableInfo => $pageableInfo, versionId => $versionId, attachment => $attachment, sort => $sort, statuses => $statuses);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WorkflowsApi->getAllWorkflowsForAttachments: $@\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 id of the catalog
currentPage = currentPage_example # String | Catalog on which to search
pageSize = pageSize_example # String | Page size for paging
pageableInfo =  # Pageable | Pageable DTO
versionId = versionId_example # String | The version of the catalog
attachment = attachment_example # String | The uuid of the CMSItem attached to the workflow (optional)
sort = sort_example # String | The requested ordering for the search results. (optional)
statuses =  # array[String] | The list of workflow statues. When none provided, the default statuses are set to RUNNING and PAUSED. This will return all active workflows. (optional) (default to ["RUNNING","PAUSED"])

try: 
    # Finds all workflows containing the given attachments.
    api_response = api_instance.get_all_workflows_for_attachments(catalogId, currentPage, pageSize, pageableInfo, versionId, attachment=attachment, sort=sort, statuses=statuses)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WorkflowsApi->getAllWorkflowsForAttachments: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The id of the catalog
Required
versionId*
String
The version of the catalog
Required
Query parameters
Name Description
attachment
String
The uuid of the CMSItem attached to the workflow
currentPage*
String
Catalog on which to search
Required
pageSize*
String
Page size for paging
Required
pageableInfo*
Pageable
Pageable DTO
Required
sort
String
The requested ordering for the search results.
statuses
array[String]
The list of workflow statues. When none provided, the default statuses are set to RUNNING and PAUSED. This will return all active workflows.

Responses

Status: 200 - The list of dtos containing the workflow info. Never null.

Status: 400 - If there is any validation error (WebserviceValidationException).

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getWorkflowByCode

Gets a workflow item.

Retrieves a specific instance of the workflow for a given workflow code.


/v1/catalogs/{catalogId}/versions/{versionId}/workflows/{workflowCode}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmswebservices/v1/catalogs/{catalogId}/versions/{versionId}/workflows/{workflowCode}"
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 id of the catalog
        String versionId = versionId_example; // String | The version of the catalog
        String workflowCode = workflowCode_example; // String | The code of the workflow
        try {
            CMSWorkflow result = apiInstance.getWorkflowByCode(catalogId, versionId, workflowCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkflowsApi#getWorkflowByCode");
            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 id of the catalog
        String versionId = versionId_example; // String | The version of the catalog
        String workflowCode = workflowCode_example; // String | The code of the workflow
        try {
            CMSWorkflow result = apiInstance.getWorkflowByCode(catalogId, versionId, workflowCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkflowsApi#getWorkflowByCode");
            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 id of the catalog
String *versionId = versionId_example; // The version of the catalog
String *workflowCode = workflowCode_example; // The code of the workflow

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

// Gets a workflow item.
[apiInstance getWorkflowByCodeWith:catalogId
    versionId:versionId
    workflowCode:workflowCode
              completionHandler: ^(CMSWorkflow output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.WorkflowsApi()
var catalogId = catalogId_example; // {{String}} The id of the catalog
var versionId = versionId_example; // {{String}} The version of the catalog
var workflowCode = workflowCode_example; // {{String}} The code of the workflow

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

namespace Example
{
    public class getWorkflowByCodeExample
    {
        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 id of the catalog
            var versionId = versionId_example;  // String | The version of the catalog
            var workflowCode = workflowCode_example;  // String | The code of the workflow

            try
            {
                // Gets a workflow item.
                CMSWorkflow result = apiInstance.getWorkflowByCode(catalogId, versionId, workflowCode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WorkflowsApi.getWorkflowByCode: " + 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 id of the catalog
$versionId = versionId_example; // String | The version of the catalog
$workflowCode = workflowCode_example; // String | The code of the workflow

try {
    $result = $api_instance->getWorkflowByCode($catalogId, $versionId, $workflowCode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WorkflowsApi->getWorkflowByCode: ', $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 id of the catalog
my $versionId = versionId_example; # String | The version of the catalog
my $workflowCode = workflowCode_example; # String | The code of the workflow

eval { 
    my $result = $api_instance->getWorkflowByCode(catalogId => $catalogId, versionId => $versionId, workflowCode => $workflowCode);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WorkflowsApi->getWorkflowByCode: $@\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 id of the catalog
versionId = versionId_example # String | The version of the catalog
workflowCode = workflowCode_example # String | The code of the workflow

try: 
    # Gets a workflow item.
    api_response = api_instance.get_workflow_by_code(catalogId, versionId, workflowCode)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WorkflowsApi->getWorkflowByCode: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The id of the catalog
Required
versionId*
String
The version of the catalog
Required
workflowCode*
String
The code of the workflow
Required

Responses

Status: 200 - The dto containing the workflow item.

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - When no workflow is found matching the given code (UnknownIdentifierException).


replaceWorkflow

Updates an existing workflow.

Provides a new workflow information for an existing workflow item.


/v1/catalogs/{catalogId}/versions/{versionId}/workflows/{workflowCode}

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/cmswebservices/v1/catalogs/{catalogId}/versions/{versionId}/workflows/{workflowCode}"
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();
        CMSWorkflow body = ; // CMSWorkflow | 
        String catalogId = catalogId_example; // String | The id of the catalog
        String versionId = versionId_example; // String | The version of the catalog
        String workflowCode = workflowCode_example; // String | The code of the workflow
        try {
            CMSWorkflow result = apiInstance.replaceWorkflow(body, catalogId, versionId, workflowCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkflowsApi#replaceWorkflow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WorkflowsApi;

public class WorkflowsApiExample {

    public static void main(String[] args) {
        WorkflowsApi apiInstance = new WorkflowsApi();
        CMSWorkflow body = ; // CMSWorkflow | 
        String catalogId = catalogId_example; // String | The id of the catalog
        String versionId = versionId_example; // String | The version of the catalog
        String workflowCode = workflowCode_example; // String | The code of the workflow
        try {
            CMSWorkflow result = apiInstance.replaceWorkflow(body, catalogId, versionId, workflowCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WorkflowsApi#replaceWorkflow");
            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"];
CMSWorkflow *body = ; // 
String *catalogId = catalogId_example; // The id of the catalog
String *versionId = versionId_example; // The version of the catalog
String *workflowCode = workflowCode_example; // The code of the workflow

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

// Updates an existing workflow.
[apiInstance replaceWorkflowWith:body
    catalogId:catalogId
    versionId:versionId
    workflowCode:workflowCode
              completionHandler: ^(CMSWorkflow output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CmsWebservices = require('cms_webservices');
var defaultClient = CmsWebservices.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 CmsWebservices.WorkflowsApi()
var body = ; // {{CMSWorkflow}} 
var catalogId = catalogId_example; // {{String}} The id of the catalog
var versionId = versionId_example; // {{String}} The version of the catalog
var workflowCode = workflowCode_example; // {{String}} The code of the workflow

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

namespace Example
{
    public class replaceWorkflowExample
    {
        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 body = new CMSWorkflow(); // CMSWorkflow | 
            var catalogId = catalogId_example;  // String | The id of the catalog
            var versionId = versionId_example;  // String | The version of the catalog
            var workflowCode = workflowCode_example;  // String | The code of the workflow

            try
            {
                // Updates an existing workflow.
                CMSWorkflow result = apiInstance.replaceWorkflow(body, catalogId, versionId, workflowCode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WorkflowsApi.replaceWorkflow: " + 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();
$body = ; // CMSWorkflow | 
$catalogId = catalogId_example; // String | The id of the catalog
$versionId = versionId_example; // String | The version of the catalog
$workflowCode = workflowCode_example; // String | The code of the workflow

try {
    $result = $api_instance->replaceWorkflow($body, $catalogId, $versionId, $workflowCode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WorkflowsApi->replaceWorkflow: ', $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 $body = WWW::SwaggerClient::Object::CMSWorkflow->new(); # CMSWorkflow | 
my $catalogId = catalogId_example; # String | The id of the catalog
my $versionId = versionId_example; # String | The version of the catalog
my $workflowCode = workflowCode_example; # String | The code of the workflow

eval { 
    my $result = $api_instance->replaceWorkflow(body => $body, catalogId => $catalogId, versionId => $versionId, workflowCode => $workflowCode);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WorkflowsApi->replaceWorkflow: $@\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()
body =  # CMSWorkflow | 
catalogId = catalogId_example # String | The id of the catalog
versionId = versionId_example # String | The version of the catalog
workflowCode = workflowCode_example # String | The code of the workflow

try: 
    # Updates an existing workflow.
    api_response = api_instance.replace_workflow(body, catalogId, versionId, workflowCode)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WorkflowsApi->replaceWorkflow: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The id of the catalog
Required
versionId*
String
The version of the catalog
Required
workflowCode*
String
The code of the workflow
Required
Body parameters
Name Description
body *

Responses

Status: 200 - The dto containing the workflow info.

Status: 400 - If there is any validation error (WebserviceValidationException).

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - When no workflow is found matching the given code (UnknownIdentifierException).