RelationApi 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

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

createRelationship({required String relationName, required String sourceType, required String sourceKey, required String targetType, required String targetKey, String? sourceStatus, String? targetStatus, int? sourceVersion, int? targetVersion}) → Future<Relation>

Creates a relationship between two entities (user, space, content). The 'favourite' relationship is supported by default, but you can use this method to create any type of relationship between two entities.

deleteRelationship({required String relationName, required String sourceType, required String sourceKey, required String targetType, required String targetKey, String? sourceStatus, String? targetStatus, int? sourceVersion, int? targetVersion}) → Future<void>

Deletes a relationship between two entities (user, space, content).

findSourcesForTarget({required String relationName, required String sourceType, required String targetType, required String targetKey, String? sourceStatus, String? targetStatus, int? sourceVersion, int? targetVersion, List<String>? expand, int? start, int? limit}) → Future<RelationArray>

Returns all target entities that have a particular relationship to the source entity. Note, relationships are one way.

findTargetFromSource({required String relationName, required String sourceType, required String sourceKey, required String targetType, String? sourceStatus, String? targetStatus, int? sourceVersion, int? targetVersion, List<String>? expand, int? start, int? limit}) → Future<RelationArray>

Returns all target entities that have a particular relationship to the source entity. Note, relationships are one way.

getRelationship({required String relationName, required String sourceType, required String sourceKey, required String targetType, required String targetKey, String? sourceStatus, String? targetStatus, int? sourceVersion, int? targetVersion, List<String>? expand}) → Future<Relation>

Find whether a particular type of relationship exists from a source entity to a target entity. Note, relationships are one way.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited