Sign in

v1

latestOpenAPI 3.0.12026-07-13130168404.3 KB
Relation

Find relationship from source to target

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

For example, you can use this method to find whether the current user has selected a particular page as a favorite (i.e. 'save for later'): GET /wiki/rest/api/relation/favourite/from/user/current/to/content/123

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

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

Path parameters

relationNamestring required

The name of the relationship. This method supports the 'favourite' (i.e. 'save for later') relationship as well as any other relationship types created via Create relationship.

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

The source entity type of the relationship. This must be 'user', if the relationName is 'favourite'.

sourceKeystring required

  • The identifier for the source entity:

  • If sourceType 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 sourceType is 'content', then specify the content ID.

  • If sourceType is 'space', then specify the space key.

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

The target entity type of the relationship. This must be 'space' or 'content', if the relationName is 'favourite'.

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.

Response

Returned if the relationship exists.

namestring required
_linksGenericLinks required