Templates API
API change historyRequest
Request URL
Request parameters
-
string
Version guid of template.
-
(optional)string
Culture for translation.
Request body
Responses
200 OK
Template details dto.
Representations
{
"allOf": [
{
"type": "object",
"description": "Concept details.",
"required": [
"createdOn"
],
"properties": {
"guid": {
"type": "string",
"description": "Gets or sets concept guid."
},
"versionGuid": {
"type": "string",
"description": "Gets or sets version Guid."
},
"version": {
"type": "string",
"description": "Gets or sets version.Subversion."
},
"createdOn": {
"type": "string",
"description": "Gets or sets created on.",
"format": "date-time"
},
"createdBy": {
"type": "string",
"description": "Gets or sets created by."
},
"changedOn": {
"type": "string",
"description": "Gets or sets changed on.",
"format": "date-time"
},
"countries": {
"type": "array",
"description": "Gets countries.",
"items": {
"type": "object",
"description": "Country summary.",
"properties": {
"code": {
"type": "string",
"description": "Gets or sets code."
},
"title": {
"type": "string",
"description": "Gets or sets title."
}
}
}
},
"fullNames": {
"type": "array",
"description": "Gets full names.",
"items": {
"type": "object",
"description": "Concept translation.",
"required": [
"isPreferred"
],
"properties": {
"guid": {
"type": "string",
"description": "Gets or sets guid of translation."
},
"text": {
"type": "string",
"description": "Gets or sets translation text."
},
"isPreferred": {
"type": "boolean",
"description": "Gets or sets a value indicating whether indicator that the translation is preferred."
},
"language": {
"type": "string",
"description": "Gets or sets language of translation."
},
"languageCode": {
"type": "string",
"description": "Gets or sets language code of translation."
}
}
}
},
"shortNames": {
"type": "array",
"description": "Gets short names.",
"items": {
"type": "object",
"description": "Concept translation.",
"required": [
"isPreferred"
],
"properties": {
"guid": {
"type": "string",
"description": "Gets or sets guid of translation."
},
"text": {
"type": "string",
"description": "Gets or sets translation text."
},
"isPreferred": {
"type": "boolean",
"description": "Gets or sets a value indicating whether indicator that the translation is preferred."
},
"language": {
"type": "string",
"description": "Gets or sets language of translation."
},
"languageCode": {
"type": "string",
"description": "Gets or sets language code of translation."
}
}
}
},
"technicalDefinitions": {
"type": "array",
"description": "Gets technical definitions.",
"items": {
"type": "object",
"description": "Concept translation.",
"required": [
"isPreferred"
],
"properties": {
"guid": {
"type": "string",
"description": "Gets or sets guid of translation."
},
"text": {
"type": "string",
"description": "Gets or sets translation text."
},
"isPreferred": {
"type": "boolean",
"description": "Gets or sets a value indicating whether indicator that the translation is preferred."
},
"language": {
"type": "string",
"description": "Gets or sets language of translation."
},
"languageCode": {
"type": "string",
"description": "Gets or sets language code of translation."
}
}
}
},
"userDefinitions": {
"type": "array",
"description": "Gets user definitions.",
"items": {
"type": "object",
"description": "Concept translation.",
"required": [
"isPreferred"
],
"properties": {
"guid": {
"type": "string",
"description": "Gets or sets guid of translation."
},
"text": {
"type": "string",
"description": "Gets or sets translation text."
},
"isPreferred": {
"type": "boolean",
"description": "Gets or sets a value indicating whether indicator that the translation is preferred."
},
"language": {
"type": "string",
"description": "Gets or sets language of translation."
},
"languageCode": {
"type": "string",
"description": "Gets or sets language code of translation."
}
}
}
},
"examples": {
"type": "array",
"description": "Gets examples.",
"items": {
"type": "object",
"description": "Concept translation.",
"required": [
"isPreferred"
],
"properties": {
"guid": {
"type": "string",
"description": "Gets or sets guid of translation."
},
"text": {
"type": "string",
"description": "Gets or sets translation text."
},
"isPreferred": {
"type": "boolean",
"description": "Gets or sets a value indicating whether indicator that the translation is preferred."
},
"language": {
"type": "string",
"description": "Gets or sets language of translation."
},
"languageCode": {
"type": "string",
"description": "Gets or sets language code of translation."
}
}
}
}
}
},
{
"type": "object",
"description": "Details of template.",
"properties": {
"productType": {
"description": "Gets or sets product type of template.",
"allOf": [
{
"type": "object",
"description": "Concept summary.",
"properties": {
"guid": {
"type": "string",
"description": "Gets or sets concept guid."
},
"versionGuid": {
"type": "string",
"description": "Gets or sets version guid."
},
"defaultName": {
"type": "string",
"description": "Gets or sets preferred full name in International English."
},
"name": {
"type": "string",
"description": "Gets or sets preferred full name in passed culture."
}
}
}
]
}
}
}
]
}{
"guid": "string",
"versionGuid": "string",
"version": "string",
"createdOn": "string",
"createdBy": "string",
"changedOn": "string",
"countries": [
{
"code": "string",
"title": "string"
}
],
"fullNames": [
{
"guid": "string",
"text": "string",
"isPreferred": true,
"language": "string",
"languageCode": "string"
}
],
"shortNames": [
{
"guid": "string",
"text": "string",
"isPreferred": true,
"language": "string",
"languageCode": "string"
}
],
"technicalDefinitions": [
{
"guid": "string",
"text": "string",
"isPreferred": true,
"language": "string",
"languageCode": "string"
}
],
"userDefinitions": [
{
"guid": "string",
"text": "string",
"isPreferred": true,
"language": "string",
"languageCode": "string"
}
],
"examples": [
{
"guid": "string",
"text": "string",
"isPreferred": true,
"language": "string",
"languageCode": "string"
}
],
"productType": {
"guid": "string",
"versionGuid": "string",
"defaultName": "string",
"name": "string"
}
}{
"allOf": [
{
"type": "object",
"description": "Concept details.",
"required": [
"createdOn"
],
"properties": {
"guid": {
"type": "string",
"description": "Gets or sets concept guid."
},
"versionGuid": {
"type": "string",
"description": "Gets or sets version Guid."
},
"version": {
"type": "string",
"description": "Gets or sets version.Subversion."
},
"createdOn": {
"type": "string",
"description": "Gets or sets created on.",
"format": "date-time"
},
"createdBy": {
"type": "string",
"description": "Gets or sets created by."
},
"changedOn": {
"type": "string",
"description": "Gets or sets changed on.",
"format": "date-time"
},
"countries": {
"type": "array",
"description": "Gets countries.",
"items": {
"type": "object",
"description": "Country summary.",
"properties": {
"code": {
"type": "string",
"description": "Gets or sets code."
},
"title": {
"type": "string",
"description": "Gets or sets title."
}
}
}
},
"fullNames": {
"type": "array",
"description": "Gets full names.",
"items": {
"type": "object",
"description": "Concept translation.",
"required": [
"isPreferred"
],
"properties": {
"guid": {
"type": "string",
"description": "Gets or sets guid of translation."
},
"text": {
"type": "string",
"description": "Gets or sets translation text."
},
"isPreferred": {
"type": "boolean",
"description": "Gets or sets a value indicating whether indicator that the translation is preferred."
},
"language": {
"type": "string",
"description": "Gets or sets language of translation."
},
"languageCode": {
"type": "string",
"description": "Gets or sets language code of translation."
}
}
}
},
"shortNames": {
"type": "array",
"description": "Gets short names.",
"items": {
"type": "object",
"description": "Concept translation.",
"required": [
"isPreferred"
],
"properties": {
"guid": {
"type": "string",
"description": "Gets or sets guid of translation."
},
"text": {
"type": "string",
"description": "Gets or sets translation text."
},
"isPreferred": {
"type": "boolean",
"description": "Gets or sets a value indicating whether indicator that the translation is preferred."
},
"language": {
"type": "string",
"description": "Gets or sets language of translation."
},
"languageCode": {
"type": "string",
"description": "Gets or sets language code of translation."
}
}
}
},
"technicalDefinitions": {
"type": "array",
"description": "Gets technical definitions.",
"items": {
"type": "object",
"description": "Concept translation.",
"required": [
"isPreferred"
],
"properties": {
"guid": {
"type": "string",
"description": "Gets or sets guid of translation."
},
"text": {
"type": "string",
"description": "Gets or sets translation text."
},
"isPreferred": {
"type": "boolean",
"description": "Gets or sets a value indicating whether indicator that the translation is preferred."
},
"language": {
"type": "string",
"description": "Gets or sets language of translation."
},
"languageCode": {
"type": "string",
"description": "Gets or sets language code of translation."
}
}
}
},
"userDefinitions": {
"type": "array",
"description": "Gets user definitions.",
"items": {
"type": "object",
"description": "Concept translation.",
"required": [
"isPreferred"
],
"properties": {
"guid": {
"type": "string",
"description": "Gets or sets guid of translation."
},
"text": {
"type": "string",
"description": "Gets or sets translation text."
},
"isPreferred": {
"type": "boolean",
"description": "Gets or sets a value indicating whether indicator that the translation is preferred."
},
"language": {
"type": "string",
"description": "Gets or sets language of translation."
},
"languageCode": {
"type": "string",
"description": "Gets or sets language code of translation."
}
}
}
},
"examples": {
"type": "array",
"description": "Gets examples.",
"items": {
"type": "object",
"description": "Concept translation.",
"required": [
"isPreferred"
],
"properties": {
"guid": {
"type": "string",
"description": "Gets or sets guid of translation."
},
"text": {
"type": "string",
"description": "Gets or sets translation text."
},
"isPreferred": {
"type": "boolean",
"description": "Gets or sets a value indicating whether indicator that the translation is preferred."
},
"language": {
"type": "string",
"description": "Gets or sets language of translation."
},
"languageCode": {
"type": "string",
"description": "Gets or sets language code of translation."
}
}
}
}
}
},
{
"type": "object",
"description": "Details of template.",
"properties": {
"productType": {
"description": "Gets or sets product type of template.",
"allOf": [
{
"type": "object",
"description": "Concept summary.",
"properties": {
"guid": {
"type": "string",
"description": "Gets or sets concept guid."
},
"versionGuid": {
"type": "string",
"description": "Gets or sets version guid."
},
"defaultName": {
"type": "string",
"description": "Gets or sets preferred full name in International English."
},
"name": {
"type": "string",
"description": "Gets or sets preferred full name in passed culture."
}
}
}
]
}
}
}
]
}{
"guid": "string",
"versionGuid": "string",
"version": "string",
"createdOn": "string",
"createdBy": "string",
"changedOn": "string",
"countries": [
{
"code": "string",
"title": "string"
}
],
"fullNames": [
{
"guid": "string",
"text": "string",
"isPreferred": true,
"language": "string",
"languageCode": "string"
}
],
"shortNames": [
{
"guid": "string",
"text": "string",
"isPreferred": true,
"language": "string",
"languageCode": "string"
}
],
"technicalDefinitions": [
{
"guid": "string",
"text": "string",
"isPreferred": true,
"language": "string",
"languageCode": "string"
}
],
"userDefinitions": [
{
"guid": "string",
"text": "string",
"isPreferred": true,
"language": "string",
"languageCode": "string"
}
],
"examples": [
{
"guid": "string",
"text": "string",
"isPreferred": true,
"language": "string",
"languageCode": "string"
}
],
"productType": {
"guid": "string",
"versionGuid": "string",
"defaultName": "string",
"name": "string"
}
}{
"allOf": [
{
"type": "object",
"description": "Concept details.",
"required": [
"createdOn"
],
"properties": {
"guid": {
"type": "string",
"description": "Gets or sets concept guid."
},
"versionGuid": {
"type": "string",
"description": "Gets or sets version Guid."
},
"version": {
"type": "string",
"description": "Gets or sets version.Subversion."
},
"createdOn": {
"type": "string",
"description": "Gets or sets created on.",
"format": "date-time"
},
"createdBy": {
"type": "string",
"description": "Gets or sets created by."
},
"changedOn": {
"type": "string",
"description": "Gets or sets changed on.",
"format": "date-time"
},
"countries": {
"type": "array",
"description": "Gets countries.",
"items": {
"type": "object",
"description": "Country summary.",
"properties": {
"code": {
"type": "string",
"description": "Gets or sets code."
},
"title": {
"type": "string",
"description": "Gets or sets title."
}
}
}
},
"fullNames": {
"type": "array",
"description": "Gets full names.",
"items": {
"type": "object",
"description": "Concept translation.",
"required": [
"isPreferred"
],
"properties": {
"guid": {
"type": "string",
"description": "Gets or sets guid of translation."
},
"text": {
"type": "string",
"description": "Gets or sets translation text."
},
"isPreferred": {
"type": "boolean",
"description": "Gets or sets a value indicating whether indicator that the translation is preferred."
},
"language": {
"type": "string",
"description": "Gets or sets language of translation."
},
"languageCode": {
"type": "string",
"description": "Gets or sets language code of translation."
}
}
}
},
"shortNames": {
"type": "array",
"description": "Gets short names.",
"items": {
"type": "object",
"description": "Concept translation.",
"required": [
"isPreferred"
],
"properties": {
"guid": {
"type": "string",
"description": "Gets or sets guid of translation."
},
"text": {
"type": "string",
"description": "Gets or sets translation text."
},
"isPreferred": {
"type": "boolean",
"description": "Gets or sets a value indicating whether indicator that the translation is preferred."
},
"language": {
"type": "string",
"description": "Gets or sets language of translation."
},
"languageCode": {
"type": "string",
"description": "Gets or sets language code of translation."
}
}
}
},
"technicalDefinitions": {
"type": "array",
"description": "Gets technical definitions.",
"items": {
"type": "object",
"description": "Concept translation.",
"required": [
"isPreferred"
],
"properties": {
"guid": {
"type": "string",
"description": "Gets or sets guid of translation."
},
"text": {
"type": "string",
"description": "Gets or sets translation text."
},
"isPreferred": {
"type": "boolean",
"description": "Gets or sets a value indicating whether indicator that the translation is preferred."
},
"language": {
"type": "string",
"description": "Gets or sets language of translation."
},
"languageCode": {
"type": "string",
"description": "Gets or sets language code of translation."
}
}
}
},
"userDefinitions": {
"type": "array",
"description": "Gets user definitions.",
"items": {
"type": "object",
"description": "Concept translation.",
"required": [
"isPreferred"
],
"properties": {
"guid": {
"type": "string",
"description": "Gets or sets guid of translation."
},
"text": {
"type": "string",
"description": "Gets or sets translation text."
},
"isPreferred": {
"type": "boolean",
"description": "Gets or sets a value indicating whether indicator that the translation is preferred."
},
"language": {
"type": "string",
"description": "Gets or sets language of translation."
},
"languageCode": {
"type": "string",
"description": "Gets or sets language code of translation."
}
}
}
},
"examples": {
"type": "array",
"description": "Gets examples.",
"items": {
"type": "object",
"description": "Concept translation.",
"required": [
"isPreferred"
],
"properties": {
"guid": {
"type": "string",
"description": "Gets or sets guid of translation."
},
"text": {
"type": "string",
"description": "Gets or sets translation text."
},
"isPreferred": {
"type": "boolean",
"description": "Gets or sets a value indicating whether indicator that the translation is preferred."
},
"language": {
"type": "string",
"description": "Gets or sets language of translation."
},
"languageCode": {
"type": "string",
"description": "Gets or sets language code of translation."
}
}
}
}
}
},
{
"type": "object",
"description": "Details of template.",
"properties": {
"productType": {
"description": "Gets or sets product type of template.",
"allOf": [
{
"type": "object",
"description": "Concept summary.",
"properties": {
"guid": {
"type": "string",
"description": "Gets or sets concept guid."
},
"versionGuid": {
"type": "string",
"description": "Gets or sets version guid."
},
"defaultName": {
"type": "string",
"description": "Gets or sets preferred full name in International English."
},
"name": {
"type": "string",
"description": "Gets or sets preferred full name in passed culture."
}
}
}
]
}
}
}
]
}401 Unauthorized
Representations
{
"type": "object",
"additionalProperties": {},
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"format": "int32"
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
}
}
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}{
"type": "object",
"additionalProperties": {},
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"format": "int32"
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
}
}
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}{
"type": "object",
"additionalProperties": {},
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"format": "int32"
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
}
}
}404 Not Found
Representations
{
"type": "object",
"additionalProperties": {},
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"format": "int32"
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
}
}
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}{
"type": "object",
"additionalProperties": {},
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"format": "int32"
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
}
}
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}{
"type": "object",
"additionalProperties": {},
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"format": "int32"
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
}
}
}Code samples
@ECHO OFF
curl -v -X GET "https://api.cobuilder.com/templates-management/api/v2/templates/{versionGuid}?culture={string}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request parameters
queryString["culture"] = "{string}";
var uri = "https://api.cobuilder.com/templates-management/api/v2/templates/{versionGuid}?" + queryString;
var response = await client.GetAsync(uri);
}
}
} // // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://api.cobuilder.com/templates-management/api/v2/templates/{versionGuid}");
builder.setParameter("culture", "{string}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
"culture": "{string}",
};
$.ajax({
url: "https://api.cobuilder.com/templates-management/api/v2/templates/{versionGuid}?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
},
type: "GET",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://api.cobuilder.com/templates-management/api/v2/templates/{versionGuid}";
NSArray* array = @[
// Request parameters
@"entities=true",
@"culture={string}",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://api.cobuilder.com/templates-management/api/v2/templates/{versionGuid}');
$url = $request->getUrl();
$headers = array(
// Request headers
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'culture' => '{string}',
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>########### Python 2.7 #############
import httplib, urllib, base64
headers = {
}
params = urllib.urlencode({
# Request parameters
'culture': '{string}',
})
try:
conn = httplib.HTTPSConnection('api.cobuilder.com')
conn.request("GET", "/templates-management/api/v2/templates/{versionGuid}?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
}
params = urllib.parse.urlencode({
# Request parameters
'culture': '{string}',
})
try:
conn = http.client.HTTPSConnection('api.cobuilder.com')
conn.request("GET", "/templates-management/api/v2/templates/{versionGuid}?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################require 'net/http'
uri = URI('https://api.cobuilder.com/templates-management/api/v2/templates/{versionGuid}')
query = URI.encode_www_form({
# Request parameters
'culture' => '{string}'
})
if query.length > 0
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
end
request = Net::HTTP::Get.new(uri.request_uri)
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body