ContentApi 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

ContentApi(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

archivePages({required Map<String, dynamic> body}) → Future<LongTask>

Archives a list of pages. The pages to be archived are specified as a list of content IDs. This API accepts the archival request and returns a task ID. The archival process happens asynchronously. Use the /longtask/

createContent({String? status, List<String>? expand, required ContentCreate body}) → Future<Content>

Deprecated, use Confluence's v2 API.

deleteContent({required String id, String? status}) → Future<void>

Deprecated, use Confluence's v2 API.

getContent({String? type, String? spaceKey, String? title, List<String>? status, String? postingDay, List<String>? expand, String? trigger, String? orderby, int? start, int? limit}) → Future<ContentArray>

Deprecated, use Confluence's v2 API.

getContentById({required String id, List<String>? status, int? version, String? embeddedContentRender, List<String>? expand, String? trigger}) → Future<Content>

Deprecated, use Confluence's v2 API.

getHistoryForContent({required String id, List<String>? expand}) → Future<ContentHistory>

Deprecated, use Confluence's v2 API.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

publishLegacyDraft({required String draftId, String? status, List<String>? expand, required ContentBlueprintDraft body}) → Future<Content>

Publishes a legacy draft of a page created from a blueprint. Legacy drafts will eventually be removed in favor of shared drafts. For now, this method works the same as Publish shared draft.

publishSharedDraft({required String draftId, String? status, List<String>? expand, required ContentBlueprintDraft body}) → Future<Content>

Publishes a shared draft of a page created from a blueprint.

searchContentByCQL({required String cql, String? cqlcontext, List<String>? expand, String? cursor, int? limit}) → Future<ContentArray>

Returns the list of content that matches a Confluence Query Language (CQL) query. For information on CQL, see: Advanced searching using CQL.

toString() → String

A string representation of this object.

inherited

updateContent({required String id, String? status, String? conflictPolicy, required ContentUpdate body}) → Future<Content>

Deprecated, use Confluence's v2 API.

Operators

operator ==(Object other) → bool

The equality operator.

inherited