TemplateApi class

This document describes the REST API and resources provided by Confluence. The REST APIs are for developers who want to integrate Confluence into their application and for administrators who want to script interactions with the Confluence server.Confluence's REST APIs provide access to resources (data entities) via URI paths. To use a REST API, your application will make an HTTP request and parse the response. The response format is JSON. Your methods will be the standard HTTP methods like GET, PUT, POST and DELETE. Because the REST API is based on open standards, you can use any web development language to access the API.

Constructors

TemplateApi(ApiClient _client)

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

createContentTemplate({required ContentTemplateCreate body}) → Future<ContentTemplate>

Creates a new content template. Note, blueprint templates cannot be created via the REST API.

getBlueprintTemplates({String? spaceKey, int? start, int? limit, List<String>? expand}) → Future<BlueprintTemplateArray>

Returns all templates provided by blueprints. Use this method to retrieve all global blueprint templates or all blueprint templates in a space.

getContentTemplate(String contentTemplateId) → Future<ContentTemplate>

Returns a content template. This includes information about template, like the name, the space or blueprint that the template is in, the body of the template, and more.

getContentTemplates({String? spaceKey, int? start, int? limit, List<String>? expand}) → Future<ContentTemplateArray>

Returns all content templates. Use this method to retrieve all global content templates or all content templates in a space.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

removeTemplate(String contentTemplateId) → Future<void>

Deletes a template. This results in different actions depending on the type of template:

toString() → String

A string representation of this object.

inherited

updateContentTemplate({required ContentTemplateUpdate body}) → Future<ContentTemplate>

Updates a content template. Note, blueprint templates cannot be updated via the REST API.

Operators

operator ==(Object other) → bool

The equality operator.

inherited