getConfigurationByKey
Find a Configuration by Key
Endpoint to retrieve cms configuration data that matches the given key value
/v1/configurations/{key}
Usage and SDK Samples
curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/smarteditwebservices/v1/configurations/{key}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConfigurationsApi;
import java.io.File;
import java.util.*;
public class ConfigurationsApiExample {
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");
ConfigurationsApi apiInstance = new ConfigurationsApi();
String key = key_example; // String | Configuration data identifier
try {
apiInstance.getConfigurationByKey(key);
} catch (ApiException e) {
System.err.println("Exception when calling ConfigurationsApi#getConfigurationByKey");
e.printStackTrace();
}
}
}
import io.swagger.client.api.ConfigurationsApi;
public class ConfigurationsApiExample {
public static void main(String[] args) {
ConfigurationsApi apiInstance = new ConfigurationsApi();
String key = key_example; // String | Configuration data identifier
try {
apiInstance.getConfigurationByKey(key);
} catch (ApiException e) {
System.err.println("Exception when calling ConfigurationsApi#getConfigurationByKey");
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 *key = key_example; // Configuration data identifier
ConfigurationsApi *apiInstance = [[ConfigurationsApi alloc] init];
// Find a Configuration by Key
[apiInstance getConfigurationByKeyWith:key
completionHandler: ^(NSError* error) {
if (error) {
NSLog(@"Error: %@", error);
}
}];
var SmarteditWebservices = require('smartedit_webservices');
var defaultClient = SmarteditWebservices.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 SmarteditWebservices.ConfigurationsApi()
var key = key_example; // {{String}} Configuration data identifier
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.getConfigurationByKey(key, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class getConfigurationByKeyExample
{
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 ConfigurationsApi();
var key = key_example; // String | Configuration data identifier
try
{
// Find a Configuration by Key
apiInstance.getConfigurationByKey(key);
}
catch (Exception e)
{
Debug.Print("Exception when calling ConfigurationsApi.getConfigurationByKey: " + 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\ApiConfigurationsApi();
$key = key_example; // String | Configuration data identifier
try {
$api_instance->getConfigurationByKey($key);
} catch (Exception $e) {
echo 'Exception when calling ConfigurationsApi->getConfigurationByKey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConfigurationsApi;
# 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::ConfigurationsApi->new();
my $key = key_example; # String | Configuration data identifier
eval {
$api_instance->getConfigurationByKey(key => $key);
};
if ($@) {
warn "Exception when calling ConfigurationsApi->getConfigurationByKey: $@\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.ConfigurationsApi()
key = key_example # String | Configuration data identifier
try:
# Find a Configuration by Key
api_instance.get_configuration_by_key(key)
except ApiException as e:
print("Exception when calling ConfigurationsApi->getConfigurationByKey: %s\n" % e)
Parameters
| Name | Description |
|---|---|
| key* |
String
Configuration data identifier
Required
|