Templates API
API change historyRequest
Request URL
Request parameters
-
(optional)integer
Format - int32.
-
(optional)integer
Format - int32.
-
(optional)string
-
(optional)string
Request body
Responses
200 OK
Returns paged list of properties with their concept guid, version guid, fullnames and default names filtered by name, according to limit and offset in the filter.
Representations
{
"type": "object",
"description": "Pagination wrapper.",
"properties": {
"results": {
"type": "array",
"description": "Gets or sets results.",
"items": {
"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."
}
}
}
},
"pagination": {
"description": "Gets or sets pagination info.",
"allOf": [
{
"type": "object",
"description": "Pagination info.",
"required": [
"total",
"take",
"skip",
"returned"
],
"properties": {
"total": {
"type": "integer",
"description": "Gets or sets total items count.",
"format": "int32"
},
"take": {
"type": "integer",
"description": "Gets or sets take parameter.",
"format": "int32"
},
"skip": {
"type": "integer",
"description": "Gets or sets skip parameter.",
"format": "int32"
},
"returned": {
"type": "integer",
"description": "Gets or sets returned items count.",
"format": "int32"
},
"next": {
"type": "string",
"description": "Gets or sets next page url."
},
"prev": {
"type": "string",
"description": "Gets or sets previous page url."
}
}
}
]
}
}
}{
"results": [
{
"guid": "string",
"versionGuid": "string",
"defaultName": "string",
"name": "string"
}
],
"pagination": {
"total": 0,
"take": 0,
"skip": 0,
"returned": 0,
"next": "string",
"prev": "string"
}
}{
"type": "object",
"description": "Pagination wrapper.",
"properties": {
"results": {
"type": "array",
"description": "Gets or sets results.",
"items": {
"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."
}
}
}
},
"pagination": {
"description": "Gets or sets pagination info.",
"allOf": [
{
"type": "object",
"description": "Pagination info.",
"required": [
"total",
"take",
"skip",
"returned"
],
"properties": {
"total": {
"type": "integer",
"description": "Gets or sets total items count.",
"format": "int32"
},
"take": {
"type": "integer",
"description": "Gets or sets take parameter.",
"format": "int32"
},
"skip": {
"type": "integer",
"description": "Gets or sets skip parameter.",
"format": "int32"
},
"returned": {
"type": "integer",
"description": "Gets or sets returned items count.",
"format": "int32"
},
"next": {
"type": "string",
"description": "Gets or sets next page url."
},
"prev": {
"type": "string",
"description": "Gets or sets previous page url."
}
}
}
]
}
}
}{
"results": [
{
"guid": "string",
"versionGuid": "string",
"defaultName": "string",
"name": "string"
}
],
"pagination": {
"total": 0,
"take": 0,
"skip": 0,
"returned": 0,
"next": "string",
"prev": "string"
}
}{
"type": "object",
"description": "Pagination wrapper.",
"properties": {
"results": {
"type": "array",
"description": "Gets or sets results.",
"items": {
"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."
}
}
}
},
"pagination": {
"description": "Gets or sets pagination info.",
"allOf": [
{
"type": "object",
"description": "Pagination info.",
"required": [
"total",
"take",
"skip",
"returned"
],
"properties": {
"total": {
"type": "integer",
"description": "Gets or sets total items count.",
"format": "int32"
},
"take": {
"type": "integer",
"description": "Gets or sets take parameter.",
"format": "int32"
},
"skip": {
"type": "integer",
"description": "Gets or sets skip parameter.",
"format": "int32"
},
"returned": {
"type": "integer",
"description": "Gets or sets returned items count.",
"format": "int32"
},
"next": {
"type": "string",
"description": "Gets or sets next page url."
},
"prev": {
"type": "string",
"description": "Gets or sets previous page url."
}
}
}
]
}
}
}400 Bad Request
Representations
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"format": "int32"
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
},
"extensions": {
"type": "object",
"additionalProperties": {}
}
}
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"extensions": {}
}{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"format": "int32"
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
},
"extensions": {
"type": "object",
"additionalProperties": {}
}
}
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"extensions": {}
}{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"format": "int32"
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
},
"extensions": {
"type": "object",
"additionalProperties": {}
}
}
}401 Unauthorized
Representations
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"format": "int32"
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
},
"extensions": {
"type": "object",
"additionalProperties": {}
}
}
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"extensions": {}
}{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"format": "int32"
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
},
"extensions": {
"type": "object",
"additionalProperties": {}
}
}
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"extensions": {}
}{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"format": "int32"
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
},
"extensions": {
"type": "object",
"additionalProperties": {}
}
}
}403 Forbidden
Representations
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"format": "int32"
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
},
"extensions": {
"type": "object",
"additionalProperties": {}
}
}
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"extensions": {}
}{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"format": "int32"
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
},
"extensions": {
"type": "object",
"additionalProperties": {}
}
}
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"extensions": {}
}{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"format": "int32"
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
},
"extensions": {
"type": "object",
"additionalProperties": {}
}
}
}404 Not Found
Representations
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"format": "int32"
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
},
"extensions": {
"type": "object",
"additionalProperties": {}
}
}
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"extensions": {}
}{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"format": "int32"
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
},
"extensions": {
"type": "object",
"additionalProperties": {}
}
}
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"extensions": {}
}{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"format": "int32"
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
},
"extensions": {
"type": "object",
"additionalProperties": {}
}
}
}Code samples
@ECHO OFF
curl -v -X GET "https://api.cobuilder.com/templates-management/api/v2/properties?Skip=0&Take=50&SearchTerm={string}&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["Skip"] = "0";
queryString["Take"] = "50";
queryString["SearchTerm"] = "{string}";
queryString["Culture"] = "{string}";
var uri = "https://api.cobuilder.com/templates-management/api/v2/properties?" + 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/properties");
builder.setParameter("Skip", "0");
builder.setParameter("Take", "50");
builder.setParameter("SearchTerm", "{string}");
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
"Skip": "0",
"Take": "50",
"SearchTerm": "{string}",
"Culture": "{string}",
};
$.ajax({
url: "https://api.cobuilder.com/templates-management/api/v2/properties?" + $.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/properties";
NSArray* array = @[
// Request parameters
@"entities=true",
@"Skip=0",
@"Take=50",
@"SearchTerm={string}",
@"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/properties');
$url = $request->getUrl();
$headers = array(
// Request headers
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'Skip' => '0',
'Take' => '50',
'SearchTerm' => '{string}',
'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
'Skip': '0',
'Take': '50',
'SearchTerm': '{string}',
'Culture': '{string}',
})
try:
conn = httplib.HTTPSConnection('api.cobuilder.com')
conn.request("GET", "/templates-management/api/v2/properties?%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
'Skip': '0',
'Take': '50',
'SearchTerm': '{string}',
'Culture': '{string}',
})
try:
conn = http.client.HTTPSConnection('api.cobuilder.com')
conn.request("GET", "/templates-management/api/v2/properties?%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/properties')
query = URI.encode_www_form({
# Request parameters
'Skip' => '0',
'Take' => '50',
'SearchTerm' => '{string}',
'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