Templates API
API change historyGet document details by document version guid.
Get document details by document version guid.
Try itRequest
Request URL
Request parameters
-
string
Version guid of document.
Request body
Responses
200 OK
Returns a detailed information about the document with type of the document, major version, minor version, guid, version guid, when it was created, the creator, when it was changed and all translations(guid, language, text and language code) by document version guid.
Representations
{
"allOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"properties": {
"guid": {
"type": "string",
"description": "Gets or sets get concept guid."
},
"versionGuid": {
"type": "string",
"description": "Gets or sets version Guid."
},
"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"
},
"fullNames": {
"type": "array",
"description": "Gets full names.",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"text": {
"type": "string"
},
"languageCode": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"guid": {
"type": "string"
},
"language": {
"type": "string"
}
}
}
]
}
},
"shortNames": {
"type": "array",
"description": "Gets short names.",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"text": {
"type": "string"
},
"languageCode": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"guid": {
"type": "string"
},
"language": {
"type": "string"
}
}
}
]
}
},
"technicalDefinitions": {
"type": "array",
"description": "Gets technical definitions.",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"text": {
"type": "string"
},
"languageCode": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"guid": {
"type": "string"
},
"language": {
"type": "string"
}
}
}
]
}
},
"userDefinitions": {
"type": "array",
"description": "Gets user definitions.",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"text": {
"type": "string"
},
"languageCode": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"guid": {
"type": "string"
},
"language": {
"type": "string"
}
}
}
]
}
},
"examples": {
"type": "array",
"description": "Gets examples.",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"text": {
"type": "string"
},
"languageCode": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"guid": {
"type": "string"
},
"language": {
"type": "string"
}
}
}
]
}
}
}
},
{
"type": "object",
"required": [
"majorVersion",
"minorVersion"
],
"properties": {
"majorVersion": {
"type": "integer",
"description": "Gets or sets major version.",
"format": "int32"
},
"minorVersion": {
"type": "integer",
"description": "Gets or sets minor version.",
"format": "int32"
}
}
}
]
},
{
"type": "object",
"properties": {
"dimensions": {
"description": "Gets or sets concept dimensions.",
"allOf": [
{
"type": "object",
"required": [
"lengthPower",
"timePower",
"massPower",
"temperaturePower",
"amountOfSubstancePower",
"electricCurrentPower",
"luminousIntensityPower"
],
"properties": {
"lengthPower": {
"type": "number",
"format": "decimal"
},
"timePower": {
"type": "number",
"format": "decimal"
},
"massPower": {
"type": "number",
"format": "decimal"
},
"temperaturePower": {
"type": "number",
"format": "decimal"
},
"amountOfSubstancePower": {
"type": "number",
"format": "decimal"
},
"electricCurrentPower": {
"type": "number",
"format": "decimal"
},
"luminousIntensityPower": {
"type": "number",
"format": "decimal"
}
}
}
]
}
}
}
]
},
{
"type": "object",
"properties": {
"dataType": {
"type": "string",
"description": "Gets or sets data type of concept."
}
}
}
]
}{
"guid": "string",
"versionGuid": "string",
"createdOn": "string",
"createdBy": "string",
"changedOn": "string",
"fullNames": [
{
"text": "string",
"languageCode": "string",
"guid": "string",
"language": "string"
}
],
"shortNames": [
{
"text": "string",
"languageCode": "string",
"guid": "string",
"language": "string"
}
],
"technicalDefinitions": [
{
"text": "string",
"languageCode": "string",
"guid": "string",
"language": "string"
}
],
"userDefinitions": [
{
"text": "string",
"languageCode": "string",
"guid": "string",
"language": "string"
}
],
"examples": [
{
"text": "string",
"languageCode": "string",
"guid": "string",
"language": "string"
}
],
"majorVersion": 0,
"minorVersion": 0,
"dimensions": {
"lengthPower": 0.0,
"timePower": 0.0,
"massPower": 0.0,
"temperaturePower": 0.0,
"amountOfSubstancePower": 0.0,
"electricCurrentPower": 0.0,
"luminousIntensityPower": 0.0
},
"dataType": "string"
}{
"allOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"properties": {
"guid": {
"type": "string",
"description": "Gets or sets get concept guid."
},
"versionGuid": {
"type": "string",
"description": "Gets or sets version Guid."
},
"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"
},
"fullNames": {
"type": "array",
"description": "Gets full names.",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"text": {
"type": "string"
},
"languageCode": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"guid": {
"type": "string"
},
"language": {
"type": "string"
}
}
}
]
}
},
"shortNames": {
"type": "array",
"description": "Gets short names.",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"text": {
"type": "string"
},
"languageCode": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"guid": {
"type": "string"
},
"language": {
"type": "string"
}
}
}
]
}
},
"technicalDefinitions": {
"type": "array",
"description": "Gets technical definitions.",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"text": {
"type": "string"
},
"languageCode": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"guid": {
"type": "string"
},
"language": {
"type": "string"
}
}
}
]
}
},
"userDefinitions": {
"type": "array",
"description": "Gets user definitions.",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"text": {
"type": "string"
},
"languageCode": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"guid": {
"type": "string"
},
"language": {
"type": "string"
}
}
}
]
}
},
"examples": {
"type": "array",
"description": "Gets examples.",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"text": {
"type": "string"
},
"languageCode": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"guid": {
"type": "string"
},
"language": {
"type": "string"
}
}
}
]
}
}
}
},
{
"type": "object",
"required": [
"majorVersion",
"minorVersion"
],
"properties": {
"majorVersion": {
"type": "integer",
"description": "Gets or sets major version.",
"format": "int32"
},
"minorVersion": {
"type": "integer",
"description": "Gets or sets minor version.",
"format": "int32"
}
}
}
]
},
{
"type": "object",
"properties": {
"dimensions": {
"description": "Gets or sets concept dimensions.",
"allOf": [
{
"type": "object",
"required": [
"lengthPower",
"timePower",
"massPower",
"temperaturePower",
"amountOfSubstancePower",
"electricCurrentPower",
"luminousIntensityPower"
],
"properties": {
"lengthPower": {
"type": "number",
"format": "decimal"
},
"timePower": {
"type": "number",
"format": "decimal"
},
"massPower": {
"type": "number",
"format": "decimal"
},
"temperaturePower": {
"type": "number",
"format": "decimal"
},
"amountOfSubstancePower": {
"type": "number",
"format": "decimal"
},
"electricCurrentPower": {
"type": "number",
"format": "decimal"
},
"luminousIntensityPower": {
"type": "number",
"format": "decimal"
}
}
}
]
}
}
}
]
},
{
"type": "object",
"properties": {
"dataType": {
"type": "string",
"description": "Gets or sets data type of concept."
}
}
}
]
}{
"guid": "string",
"versionGuid": "string",
"createdOn": "string",
"createdBy": "string",
"changedOn": "string",
"fullNames": [
{
"text": "string",
"languageCode": "string",
"guid": "string",
"language": "string"
}
],
"shortNames": [
{
"text": "string",
"languageCode": "string",
"guid": "string",
"language": "string"
}
],
"technicalDefinitions": [
{
"text": "string",
"languageCode": "string",
"guid": "string",
"language": "string"
}
],
"userDefinitions": [
{
"text": "string",
"languageCode": "string",
"guid": "string",
"language": "string"
}
],
"examples": [
{
"text": "string",
"languageCode": "string",
"guid": "string",
"language": "string"
}
],
"majorVersion": 0,
"minorVersion": 0,
"dimensions": {
"lengthPower": 0.0,
"timePower": 0.0,
"massPower": 0.0,
"temperaturePower": 0.0,
"amountOfSubstancePower": 0.0,
"electricCurrentPower": 0.0,
"luminousIntensityPower": 0.0
},
"dataType": "string"
}{
"allOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"properties": {
"guid": {
"type": "string",
"description": "Gets or sets get concept guid."
},
"versionGuid": {
"type": "string",
"description": "Gets or sets version Guid."
},
"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"
},
"fullNames": {
"type": "array",
"description": "Gets full names.",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"text": {
"type": "string"
},
"languageCode": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"guid": {
"type": "string"
},
"language": {
"type": "string"
}
}
}
]
}
},
"shortNames": {
"type": "array",
"description": "Gets short names.",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"text": {
"type": "string"
},
"languageCode": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"guid": {
"type": "string"
},
"language": {
"type": "string"
}
}
}
]
}
},
"technicalDefinitions": {
"type": "array",
"description": "Gets technical definitions.",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"text": {
"type": "string"
},
"languageCode": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"guid": {
"type": "string"
},
"language": {
"type": "string"
}
}
}
]
}
},
"userDefinitions": {
"type": "array",
"description": "Gets user definitions.",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"text": {
"type": "string"
},
"languageCode": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"guid": {
"type": "string"
},
"language": {
"type": "string"
}
}
}
]
}
},
"examples": {
"type": "array",
"description": "Gets examples.",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"text": {
"type": "string"
},
"languageCode": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"guid": {
"type": "string"
},
"language": {
"type": "string"
}
}
}
]
}
}
}
},
{
"type": "object",
"required": [
"majorVersion",
"minorVersion"
],
"properties": {
"majorVersion": {
"type": "integer",
"description": "Gets or sets major version.",
"format": "int32"
},
"minorVersion": {
"type": "integer",
"description": "Gets or sets minor version.",
"format": "int32"
}
}
}
]
},
{
"type": "object",
"properties": {
"dimensions": {
"description": "Gets or sets concept dimensions.",
"allOf": [
{
"type": "object",
"required": [
"lengthPower",
"timePower",
"massPower",
"temperaturePower",
"amountOfSubstancePower",
"electricCurrentPower",
"luminousIntensityPower"
],
"properties": {
"lengthPower": {
"type": "number",
"format": "decimal"
},
"timePower": {
"type": "number",
"format": "decimal"
},
"massPower": {
"type": "number",
"format": "decimal"
},
"temperaturePower": {
"type": "number",
"format": "decimal"
},
"amountOfSubstancePower": {
"type": "number",
"format": "decimal"
},
"electricCurrentPower": {
"type": "number",
"format": "decimal"
},
"luminousIntensityPower": {
"type": "number",
"format": "decimal"
}
}
}
]
}
}
}
]
},
{
"type": "object",
"properties": {
"dataType": {
"type": "string",
"description": "Gets or sets data type of concept."
}
}
}
]
}400 Bad Request
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"
}
}
}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"
}
}
}403 Forbidden
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/documents/{versionGuid}"
--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);
var uri = "https://api.cobuilder.com/templates-management/api/v2/documents/{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/documents/{versionGuid}");
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
};
$.ajax({
url: "https://api.cobuilder.com/templates-management/api/v2/documents/{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/documents/{versionGuid}";
NSArray* array = @[
// Request parameters
@"entities=true",
];
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/documents/{versionGuid}');
$url = $request->getUrl();
$headers = array(
// Request headers
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$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({
})
try:
conn = httplib.HTTPSConnection('api.cobuilder.com')
conn.request("GET", "/templates-management/api/v2/documents/{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({
})
try:
conn = http.client.HTTPSConnection('api.cobuilder.com')
conn.request("GET", "/templates-management/api/v2/documents/{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/documents/{versionGuid}')
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