getContentCatalogs
Get content catalogs
Endpoint to retrieve content catalog information including the related catalog versions for all catalogs for a given site and its parents.
/v1/sites/{baseSiteId}/contentcatalogs
Usage and SDK Samples
curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/cmssmarteditwebservices/v1/sites/{baseSiteId}/contentcatalogs"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CatalogsApi;
import java.io.File;
import java.util.*;
public class CatalogsApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure OAuth2 access token for authorization: oauth2_Password
OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");
// Configure OAuth2 access token for authorization: oauth2_client_credentials
OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");
CatalogsApi apiInstance = new CatalogsApi();
String baseSiteId = baseSiteId_example; // String | The site identifier
try {
CatalogList result = apiInstance.getContentCatalogs(baseSiteId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CatalogsApi#getContentCatalogs");
e.printStackTrace();
}
}
}
import io.swagger.client.api.CatalogsApi;
public class CatalogsApiExample {
public static void main(String[] args) {
CatalogsApi apiInstance = new CatalogsApi();
String baseSiteId = baseSiteId_example; // String | The site identifier
try {
CatalogList result = apiInstance.getContentCatalogs(baseSiteId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CatalogsApi#getContentCatalogs");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *baseSiteId = baseSiteId_example; // The site identifier
CatalogsApi *apiInstance = [[CatalogsApi alloc] init];
// Get content catalogs
[apiInstance getContentCatalogsWith:baseSiteId
completionHandler: ^(CatalogList output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var CmsSmartEditWebservices = require('cms_smart_edit_webservices');
var defaultClient = CmsSmartEditWebservices.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"
// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"
var api = new CmsSmartEditWebservices.CatalogsApi()
var baseSiteId = baseSiteId_example; // {{String}} The site identifier
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getContentCatalogs(baseSiteId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class getContentCatalogsExample
{
public void main()
{
// Configure OAuth2 access token for authorization: oauth2_Password
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new CatalogsApi();
var baseSiteId = baseSiteId_example; // String | The site identifier
try
{
// Get content catalogs
CatalogList result = apiInstance.getContentCatalogs(baseSiteId);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling CatalogsApi.getContentCatalogs: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new Swagger\Client\ApiCatalogsApi();
$baseSiteId = baseSiteId_example; // String | The site identifier
try {
$result = $api_instance->getContentCatalogs($baseSiteId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CatalogsApi->getContentCatalogs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CatalogsApi;
# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
my $api_instance = WWW::SwaggerClient::CatalogsApi->new();
my $baseSiteId = baseSiteId_example; # String | The site identifier
eval {
my $result = $api_instance->getContentCatalogs(baseSiteId => $baseSiteId);
print Dumper($result);
};
if ($@) {
warn "Exception when calling CatalogsApi->getContentCatalogs: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.CatalogsApi()
baseSiteId = baseSiteId_example # String | The site identifier
try:
# Get content catalogs
api_response = api_instance.get_content_catalogs(baseSiteId)
pprint(api_response)
except ApiException as e:
print("Exception when calling CatalogsApi->getContentCatalogs: %s\n" % e)
Parameters
| Name | Description |
|---|---|
| baseSiteId* |
String
The site identifier
Required
|