Get a template's XML from the public template library

Answers one library template's XML - the file the console's template Import takes - without installing it, so it can be handed to someone or imported elsewhere.

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/template-catalog/xml.do

Answers one library template's XML - the file the console's template Import takes - without installing it, so it can be handed to someone or imported elsewhere. The copy is checked against the library's catalog first. Requires the Templates create permission and the Templates view permission on all templates (the library reports what the whole network holds).

Query Params

entryId string required

The library template's id, as the library list gives it

catfish/catfish/mobile-catfish

Responses

200

success true, entryId, name, uniqueId, buildVersion, placementType, templateType and xml (the template XML as text)

400

Bad request — invalid or missing parameters

401

Authentication error

403

No Templates create permission, or Templates view is not granted on all templates

404

No such template in the library

503

The template library is not set up on this network, could not be read, or its copy does not match its catalog

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/template-catalog/xml.do?entryId=catfish%2Fcatfish%2Fmobile-catfish' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/template-catalog/xml.do?entryId=catfish%2Fcatfish%2Fmobile-catfish", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/template-catalog/xml.do?entryId=catfish%2Fcatfish%2Fmobile-catfish', {
  method: 'GET',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/template-catalog/xml.do?entryId=catfish%2Fcatfish%2Fmobile-catfish"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("GET"), "https://YOUR-NETWORK-DOMAIN/rest-api/template-catalog/xml.do?entryId=catfish%2Fcatfish%2Fmobile-catfish");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/template-catalog/xml.do?entryId=catfish%2Fcatfish%2Fmobile-catfish", nil)
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/template-catalog/xml.do?entryId=catfish%2Fcatfish%2Fmobile-catfish");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY"]);

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/template-catalog/xml.do?entryId=catfish%2Fcatfish%2Fmobile-catfish")
request = Net::HTTP::Get.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body