Sign in

v1

latestOpenAPI 3.0.12026-07-13130168404.3 KB
Relation

Find source entities related to a target entity

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

For example, the following method finds all users that have a 'collaborator' relationship to a piece of content with an ID of '1234': GET /wiki/rest/api/relation/collaborator/to/content/1234/from/user Note, 'collaborator' is an example custom relationship type.

Permissions required: Permission to view both the target entity and source entity.

get/wiki/rest/api/relation/{relationName}/to/{targetType}/{targetKey}/from/{sourceType}

Path parameters

relationNamestring required

The name of the relationship. This method supports relationships created via Create relationship. Note, this method does not support 'like' or 'favourite' relationships.

sourceType'user' | 'content' | 'space' required

The source entity type of the relationship.

targetType'user' | 'content' | 'space' required

The target entity type of the relationship.

targetKeystring required

The identifier for the target entity:

  • If targetType is user, then specify either current (logged-in user), the user key of the user, or the account ID of the user. Note that the user key has been deprecated in favor of the account ID for this parameter. See the migration guide for details.
  • If targetType is 'content', then specify the content ID.
  • If targetType is 'space', then specify the space key.

Query parameters

sourceStatusstring

The status of the source. This parameter is only used when the sourceType is 'content'.

targetStatusstring

The status of the target. This parameter is only used when the targetType is 'content'.

sourceVersioninteger

The version of the source. This parameter is only used when the sourceType is 'content' and the sourceStatus is 'historical'.

targetVersioninteger

The version of the target. This parameter is only used when the targetType is 'content' and the targetStatus is 'historical'.

expandstring[]

A multi-value parameter indicating which properties of the response object to expand.

  • relationData returns information about the relationship, such as who created it and when it was created.
  • source returns the source entity.
  • target returns the target entity.
startinteger

The starting index of the returned relationships.

limitinteger

The maximum number of relationships to return per page. Note, this may be restricted by fixed system limits.

Response

Returned if the requested relationships are returned.

startinteger required
limitinteger required
sizeinteger required
_linksGenericLinks required