Python / Atlassian Confluence Cloud / Find source entities related to a target entity
Back to Collection Items
import sys
import chilkat
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = chilkat.CkHttp()
queryParams = chilkat.CkJsonObject()
queryParams.UpdateString("sourceStatus","<string>")
queryParams.UpdateString("targetStatus","<string>")
queryParams.UpdateString("sourceVersion","<integer>")
queryParams.UpdateString("targetVersion","<integer>")
queryParams.UpdateString("expand","<string>")
queryParams.UpdateString("expand","<string>")
queryParams.UpdateInt("start",0)
queryParams.UpdateInt("limit",25)
# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://your-domain.atlassian.net/wiki/rest/api/relation/:relationName/to/:targetType/:targetKey/from/:sourceType",queryParams)
if (http.get_LastMethodSuccess() == False):
print(http.lastErrorText())
sys.exit()
sbResponseBody = chilkat.CkStringBuilder()
resp.GetBodySb(sbResponseBody)
jResp = chilkat.CkJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(False)
print("Response Body:")
print(jResp.emit())
respStatusCode = resp.get_StatusCode()
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
print("Response Header:")
print(resp.header())
print("Failed.")
sys.exit()
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "results": [
# {
# "name": "eiusmod sunt laboris",
# "_expandable": {
# "relationData": "velit veniam",
# "source": "eiusmod",
# "target": "ea consectetur cupidatat ad adipisicing"
# },
# "_links": {},
# "relationData": {
# "createdBy": {
# "type": "user",
# "accountId": "velit in exercitation laboris",
# "accountType": "atlassian",
# "email": "id voluptate",
# "publicName": "deserunt",
# "profilePicture": {
# "path": "ut fugiat",
# "width": -38683687,
# "height": 65248683,
# "isDefault": true
# },
# "displayName": "velit commodo ullamco ipsum",
# "_expandable": {
# "operations": "id veniam",
# "details": "pariatur",
# "personalSpace": "enim nostrud exercitation consequat"
# },
# "_links": {},
# "username": "sed ullamco",
# "userKey": "esse quis elit",
# "operations": [
# {
# "operation": "read",
# "targetType": "attachment"
# },
# {
# "operation": "read",
# "targetType": "page"
# }
# ],
# "details": {
# "business": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "personal": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# "personalSpace": {
# "id": -57606158,
# "key": "sunt cillum aute",
# "name": "dolore elit ea in",
# "type": "non in",
# "status": "aliquip et anim",
# "_expandable": {
# "settings": "ex dolor deserunt anim",
# "metadata": "dolore qui officia Duis",
# "operations": "sed laboris",
# "lookAndFeel": "Duis elit dolore veniam",
# "permissions": "dolor dolore in",
# "icon": "reprehenderit pariatur magna labore irure",
# "description": "Duis aute est fugiat laborum",
# "theme": "qui nulla est",
# "history": "non fugiat do",
# "homepage": "nisi"
# },
# "_links": {},
# "icon": {
# "path": "est labore",
# "width": -327281,
# "height": -79671930,
# "isDefault": false
# },
# "description": {
# "plain": {
# "value": "esse dolore",
# "representation": "view",
# "embeddedContent": [
# {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# ]
# },
# "view": {
# "value": "commodo",
# "representation": "view",
# "embeddedContent": [
# {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# ]
# }
# },
# "homepage": {
# "value": "<Circular reference to #/components/schemas/Content detected>"
# },
# "metadata": {
# "labels": {
# "results": [
# {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# ],
# "start": -56637757,
# "limit": 1062771,
# "size": 37957067,
# "_links": {}
# }
# },
# "operations": [
# {
# "operation": "update",
# "targetType": "page"
# },
# {
# "operation": "move",
# "targetType": "attachment"
# }
# ],
# "permissions": [
# {
# "subjects": {
# "_expandable": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "user": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "group": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# "operation": {
# "operation": "purge_version",
# "targetType": "page"
# },
# "anonymousAccess": false,
# "unlicensedAccess": false
# },
# {
# "subjects": {
# "_expandable": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "user": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "group": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# "operation": {
# "operation": "purge",
# "targetType": "page"
# },
# "anonymousAccess": false,
# "unlicensedAccess": false
# }
# ],
# "settings": {
# "routeOverrideEnabled": true,
# "_links": {}
# },
# "theme": {},
# "lookAndFeel": {
# "headings": {
# "color": "se"
# },
# "links": {
# "color": "sit"
# },
# "menus": {
# "hoverOrFocus": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "color": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# "header": {
# "backgroundColor": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "button": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "primaryNavigation": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "secondaryNavigation": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "search": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# "content": {
# "screen": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "container": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "header": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "body": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# "bordersAndDividers": {
# "color": "magna consequat"
# }
# },
# "history": {
# "createdDate": "1951-04-28T13:26:19.420Z"
# }
# }
# },
# "createdDate": "1945-06-14T04:34:24.316Z",
# "friendlyCreatedDate": "reprehenderit "
# },
# "source": {},
# "target": {}
# },
# {
# "name": "consectetur Ut enim occaec",
# "_expandable": {
# "relationData": "in est qui",
# "source": "incididunt",
# "target": "laborum magna proident amet aliquip"
# },
# "_links": {},
# "relationData": {
# "createdBy": {
# "type": "user",
# "accountId": "cillu",
# "accountType": "app (if this user is a bot user created on behalf of an Atlassian app)",
# "email": "enim eu",
# "publicName": "eu aute in",
# "profilePicture": {
# "path": "non",
# "width": -48499479,
# "height": 87770702,
# "isDefault": true
# },
# "displayName": "dolore ut",
# "_expandable": {
# "operations": "magna pariatur eiusmod nisi",
# "details": "non consectetur",
# "personalSpace": "nostrud"
# },
# "_links": {},
# "username": "anim aliquip eu amet",
# "userKey": "dolore ullamco nostrud laboris",
# "operations": [
# {
# "operation": "administer",
# "targetType": "comment"
# },
# {
# "operation": "export",
# "targetType": "space"
# }
# ],
# "details": {
# "business": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "personal": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# "personalSpace": {
# "id": 96005227,
# "key": "elit eiusmod ad",
# "name": "in tempor ad",
# "type": "et elit officia",
# "status": "dolore",
# "_expandable": {
# "settings": "ad aliquip nisi sed",
# "metadata": "ut cupidatat",
# "operations": "veniam sit",
# "lookAndFeel": "anim ex",
# "permissions": "mollit qui Lorem nulla quis",
# "icon": "amet fugiat dolor cupidatat",
# "description": "consequat anim",
# "theme": "ipsum",
# "history": "aliqua Dui",
# "homepage": "voluptate consectetur do Ut ut"
# },
# "_links": {},
# "icon": {
# "path": "ex minim consectetur",
# "width": -35571565,
# "height": -58278363,
# "isDefault": false
# },
# "description": {
# "plain": {
# "value": "dolor exercitation",
# "representation": "plain",
# "embeddedContent": [
# {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# ]
# },
# "view": {
# "value": "velit irure laborum id nostrud",
# "representation": "view",
# "embeddedContent": [
# {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# ]
# }
# },
# "homepage": {
# "value": "<Circular reference to #/components/schemas/Content detected>"
# },
# "metadata": {
# "labels": {
# "results": [
# {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# ],
# "start": 36294069,
# "limit": -28282967,
# "size": 56940014,
# "_links": {}
# }
# },
# "operations": [
# {
# "operation": "administer",
# "targetType": "blogpost"
# },
# {
# "operation": "read",
# "targetType": "application"
# }
# ],
# "permissions": [
# {
# "subjects": {
# "_expandable": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "user": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "group": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# "operation": {
# "operation": "purge",
# "targetType": "attachment"
# },
# "anonymousAccess": false,
# "unlicensedAccess": false
# },
# {
# "subjects": {
# "_expandable": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "user": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "group": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# "operation": {
# "operation": "create",
# "targetType": "space"
# },
# "anonymousAccess": false,
# "unlicensedAccess": false
# }
# ],
# "settings": {
# "routeOverrideEnabled": false,
# "_links": {}
# },
# "theme": {},
# "lookAndFeel": {
# "headings": {
# "color": "dolore consequat occaeca"
# },
# "links": {
# "color": "occaecat ut sit"
# },
# "menus": {
# "hoverOrFocus": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "color": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# "header": {
# "backgroundColor": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "button": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "primaryNavigation": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "secondaryNavigation": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "search": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# "content": {
# "screen": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "container": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "header": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "body": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# "bordersAndDividers": {
# "color": "deserunt Duis laborum ad"
# }
# },
# "history": {
# "createdDate": "1977-01-29T01:15:06.769Z"
# }
# }
# },
# "createdDate": "2018-11-14T12:56:13.456Z",
# "friendlyCreatedDate": "reprehenderit laborum"
# },
# "source": {},
# "target": {}
# }
# ],
# "start": -48357202,
# "limit": 5335291,
# "size": 43833338,
# "_links": {}
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
start = jResp.IntOf("start")
limit = jResp.IntOf("limit")
size = jResp.IntOf("size")
i = 0
count_i = jResp.SizeOfArray("results")
while i < count_i :
jResp.put_I(i)
name = jResp.stringOf("results[i].name")
RelationData = jResp.stringOf("results[i]._expandable.relationData")
Source = jResp.stringOf("results[i]._expandable.source")
Target = jResp.stringOf("results[i]._expandable.target")
v_Type = jResp.stringOf("results[i].relationData.createdBy.type")
AccountId = jResp.stringOf("results[i].relationData.createdBy.accountId")
AccountType = jResp.stringOf("results[i].relationData.createdBy.accountType")
v_Email = jResp.stringOf("results[i].relationData.createdBy.email")
PublicName = jResp.stringOf("results[i].relationData.createdBy.publicName")
Path = jResp.stringOf("results[i].relationData.createdBy.profilePicture.path")
Width = jResp.IntOf("results[i].relationData.createdBy.profilePicture.width")
Height = jResp.IntOf("results[i].relationData.createdBy.profilePicture.height")
IsDefault = jResp.BoolOf("results[i].relationData.createdBy.profilePicture.isDefault")
DisplayName = jResp.stringOf("results[i].relationData.createdBy.displayName")
Operations = jResp.stringOf("results[i].relationData.createdBy._expandable.operations")
Details = jResp.stringOf("results[i].relationData.createdBy._expandable.details")
PersonalSpace = jResp.stringOf("results[i].relationData.createdBy._expandable.personalSpace")
Username = jResp.stringOf("results[i].relationData.createdBy.username")
UserKey = jResp.stringOf("results[i].relationData.createdBy.userKey")
Value = jResp.stringOf("results[i].relationData.createdBy.details.business.value")
PersonalValue = jResp.stringOf("results[i].relationData.createdBy.details.personal.value")
Id = jResp.IntOf("results[i].relationData.createdBy.personalSpace.id")
Key = jResp.stringOf("results[i].relationData.createdBy.personalSpace.key")
Name = jResp.stringOf("results[i].relationData.createdBy.personalSpace.name")
PersonalSpaceType = jResp.stringOf("results[i].relationData.createdBy.personalSpace.type")
Status = jResp.stringOf("results[i].relationData.createdBy.personalSpace.status")
Settings = jResp.stringOf("results[i].relationData.createdBy.personalSpace._expandable.settings")
Metadata = jResp.stringOf("results[i].relationData.createdBy.personalSpace._expandable.metadata")
v_expandableOperations = jResp.stringOf("results[i].relationData.createdBy.personalSpace._expandable.operations")
LookAndFeel = jResp.stringOf("results[i].relationData.createdBy.personalSpace._expandable.lookAndFeel")
Permissions = jResp.stringOf("results[i].relationData.createdBy.personalSpace._expandable.permissions")
Icon = jResp.stringOf("results[i].relationData.createdBy.personalSpace._expandable.icon")
Description = jResp.stringOf("results[i].relationData.createdBy.personalSpace._expandable.description")
Theme = jResp.stringOf("results[i].relationData.createdBy.personalSpace._expandable.theme")
History = jResp.stringOf("results[i].relationData.createdBy.personalSpace._expandable.history")
Homepage = jResp.stringOf("results[i].relationData.createdBy.personalSpace._expandable.homepage")
IconPath = jResp.stringOf("results[i].relationData.createdBy.personalSpace.icon.path")
IconWidth = jResp.IntOf("results[i].relationData.createdBy.personalSpace.icon.width")
IconHeight = jResp.IntOf("results[i].relationData.createdBy.personalSpace.icon.height")
IconIsDefault = jResp.BoolOf("results[i].relationData.createdBy.personalSpace.icon.isDefault")
PlainValue = jResp.stringOf("results[i].relationData.createdBy.personalSpace.description.plain.value")
Representation = jResp.stringOf("results[i].relationData.createdBy.personalSpace.description.plain.representation")
ViewValue = jResp.stringOf("results[i].relationData.createdBy.personalSpace.description.view.value")
ViewRepresentation = jResp.stringOf("results[i].relationData.createdBy.personalSpace.description.view.representation")
HomepageValue = jResp.stringOf("results[i].relationData.createdBy.personalSpace.homepage.value")
Start = jResp.IntOf("results[i].relationData.createdBy.personalSpace.metadata.labels.start")
Limit = jResp.IntOf("results[i].relationData.createdBy.personalSpace.metadata.labels.limit")
Size = jResp.IntOf("results[i].relationData.createdBy.personalSpace.metadata.labels.size")
RouteOverrideEnabled = jResp.BoolOf("results[i].relationData.createdBy.personalSpace.settings.routeOverrideEnabled")
Color = jResp.stringOf("results[i].relationData.createdBy.personalSpace.lookAndFeel.headings.color")
LinksColor = jResp.stringOf("results[i].relationData.createdBy.personalSpace.lookAndFeel.links.color")
HoverOrFocusValue = jResp.stringOf("results[i].relationData.createdBy.personalSpace.lookAndFeel.menus.hoverOrFocus.value")
ColorValue = jResp.stringOf("results[i].relationData.createdBy.personalSpace.lookAndFeel.menus.color.value")
BackgroundColorValue = jResp.stringOf("results[i].relationData.createdBy.personalSpace.lookAndFeel.header.backgroundColor.value")
ButtonValue = jResp.stringOf("results[i].relationData.createdBy.personalSpace.lookAndFeel.header.button.value")
PrimaryNavigationValue = jResp.stringOf("results[i].relationData.createdBy.personalSpace.lookAndFeel.header.primaryNavigation.value")
SecondaryNavigationValue = jResp.stringOf("results[i].relationData.createdBy.personalSpace.lookAndFeel.header.secondaryNavigation.value")
SearchValue = jResp.stringOf("results[i].relationData.createdBy.personalSpace.lookAndFeel.header.search.value")
ScreenValue = jResp.stringOf("results[i].relationData.createdBy.personalSpace.lookAndFeel.content.screen.value")
ContainerValue = jResp.stringOf("results[i].relationData.createdBy.personalSpace.lookAndFeel.content.container.value")
HeaderValue = jResp.stringOf("results[i].relationData.createdBy.personalSpace.lookAndFeel.content.header.value")
BodyValue = jResp.stringOf("results[i].relationData.createdBy.personalSpace.lookAndFeel.content.body.value")
BordersAndDividersColor = jResp.stringOf("results[i].relationData.createdBy.personalSpace.lookAndFeel.bordersAndDividers.color")
CreatedDate = jResp.stringOf("results[i].relationData.createdBy.personalSpace.history.createdDate")
relationDataCreatedDate = jResp.stringOf("results[i].relationData.createdDate")
FriendlyCreatedDate = jResp.stringOf("results[i].relationData.friendlyCreatedDate")
j = 0
count_j = jResp.SizeOfArray("results[i].relationData.createdBy.operations")
while j < count_j :
jResp.put_J(j)
operation = jResp.stringOf("results[i].relationData.createdBy.operations[j].operation")
targetType = jResp.stringOf("results[i].relationData.createdBy.operations[j].targetType")
j = j + 1
j = 0
count_j = jResp.SizeOfArray("results[i].relationData.createdBy.personalSpace.description.plain.embeddedContent")
while j < count_j :
jResp.put_J(j)
value = jResp.stringOf("results[i].relationData.createdBy.personalSpace.description.plain.embeddedContent[j].value")
j = j + 1
j = 0
count_j = jResp.SizeOfArray("results[i].relationData.createdBy.personalSpace.description.view.embeddedContent")
while j < count_j :
jResp.put_J(j)
value = jResp.stringOf("results[i].relationData.createdBy.personalSpace.description.view.embeddedContent[j].value")
j = j + 1
j = 0
count_j = jResp.SizeOfArray("results[i].relationData.createdBy.personalSpace.metadata.labels.results")
while j < count_j :
jResp.put_J(j)
value = jResp.stringOf("results[i].relationData.createdBy.personalSpace.metadata.labels.results[j].value")
j = j + 1
j = 0
count_j = jResp.SizeOfArray("results[i].relationData.createdBy.personalSpace.operations")
while j < count_j :
jResp.put_J(j)
operation = jResp.stringOf("results[i].relationData.createdBy.personalSpace.operations[j].operation")
targetType = jResp.stringOf("results[i].relationData.createdBy.personalSpace.operations[j].targetType")
j = j + 1
j = 0
count_j = jResp.SizeOfArray("results[i].relationData.createdBy.personalSpace.permissions")
while j < count_j :
jResp.put_J(j)
v_expandableValue = jResp.stringOf("results[i].relationData.createdBy.personalSpace.permissions[j].subjects._expandable.value")
UserValue = jResp.stringOf("results[i].relationData.createdBy.personalSpace.permissions[j].subjects.user.value")
GroupValue = jResp.stringOf("results[i].relationData.createdBy.personalSpace.permissions[j].subjects.group.value")
Operation = jResp.stringOf("results[i].relationData.createdBy.personalSpace.permissions[j].operation.operation")
TargetType = jResp.stringOf("results[i].relationData.createdBy.personalSpace.permissions[j].operation.targetType")
anonymousAccess = jResp.BoolOf("results[i].relationData.createdBy.personalSpace.permissions[j].anonymousAccess")
unlicensedAccess = jResp.BoolOf("results[i].relationData.createdBy.personalSpace.permissions[j].unlicensedAccess")
j = j + 1
i = i + 1
Curl Command
curl -G -d "sourceStatus=%3Cstring%3E"
-d "targetStatus=%3Cstring%3E"
-d "sourceVersion=%3Cinteger%3E"
-d "targetVersion=%3Cinteger%3E"
-d "expand=%3Cstring%3E"
-d "expand=%3Cstring%3E"
-d "start=0"
-d "limit=25"
-H "Authorization: Bearer <access_token>"
https://your-domain.atlassian.net/wiki/rest/api/relation/:relationName/to/:targetType/:targetKey/from/:sourceType
Postman Collection Item JSON
{
"name": "Find source entities related to a target entity",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/relation/:relationName/to/:targetType/:targetKey/from/:sourceType?sourceStatus=<string>&targetStatus=<string>&sourceVersion=<integer>&targetVersion=<integer>&expand=<string>&expand=<string>&start=0&limit=25",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"relation",
":relationName",
"to",
":targetType",
":targetKey",
"from",
":sourceType"
],
"query": [
{
"key": "sourceStatus",
"value": "<string>",
"description": "The status of the source. This parameter is only used when the\n`sourceType` is 'content'."
},
{
"key": "targetStatus",
"value": "<string>",
"description": "The status of the target. This parameter is only used when the\n`targetType` is 'content'."
},
{
"key": "sourceVersion",
"value": "<integer>",
"description": "The version of the source. This parameter is only used when the\n`sourceType` is 'content' and the `sourceStatus` is 'historical'."
},
{
"key": "targetVersion",
"value": "<integer>",
"description": "The version of the target. This parameter is only used when the\n`targetType` is 'content' and the `targetStatus` is 'historical'."
},
{
"key": "expand",
"value": "<string>",
"description": "A multi-value parameter indicating which properties of the response\nobject to expand.\n\n- `relationData` returns information about the relationship, such as\nwho created it and when it was created.\n- `source` returns the source entity.\n- `target` returns the target entity."
},
{
"key": "expand",
"value": "<string>",
"description": "A multi-value parameter indicating which properties of the response\nobject to expand.\n\n- `relationData` returns information about the relationship, such as\nwho created it and when it was created.\n- `source` returns the source entity.\n- `target` returns the target entity."
},
{
"key": "start",
"value": "0",
"description": "The starting index of the returned relationships."
},
{
"key": "limit",
"value": "25",
"description": "The maximum number of relationships to return per page.\nNote, this may be restricted by fixed system limits."
}
],
"variable": [
{
"key": "relationName",
"value": "<string>",
"type": "string",
"description": "(Required) The name of the relationship. This method supports relationships created via\n[Create relationship](#api-relation-relationName-from-sourceType-sourceKey-to-targetType-targetKey-put).\nNote, this method does not support 'favourite' relationships."
},
{
"key": "sourceType",
"value": "<string>",
"type": "string",
"description": "(Required) The source entity type of the relationship."
},
{
"key": "targetType",
"value": "<string>",
"type": "string",
"description": "(Required) The target entity type of the relationship."
},
{
"key": "targetKey",
"value": "<string>",
"type": "string",
"description": "(Required) The identifier for the target entity:\n\n- If `targetType` is `user`, then specify either `current` (logged-in user), the user key of the user, or\nthe account ID of the user. Note that the user key has been deprecated in favor of the account ID for this parameter. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.\n- If `targetType` is 'content', then specify the content ID.\n- If `targetType` is 'space', then specify the space key."
}
]
},
"description": "Returns all target entities that have a particular relationship to the\nsource entity. Note, relationships are one way.\n\nFor example, the following method finds all users that have a 'collaborator'\nrelationship to a piece of content with an ID of '1234':\n`GET https://your-domain.atlassian.net/wiki/rest/api/relation/collaborator/to/content/1234/from/user`\nNote, 'collaborator' is an example custom relationship type.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view both the target entity and source entity."
},
"response": [
{
"name": "Returned if the requested relationships are returned.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": {
"content": "Added as a part of security scheme: oauth2",
"type": "text/plain"
},
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/api/relation/:relationName/to/:targetType/:targetKey/from/:sourceType?sourceStatus=<string>&targetStatus=<string>&sourceVersion=<integer>&targetVersion=<integer>&expand=<string>&expand=<string>&start=0&limit=25",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"relation",
":relationName",
"to",
":targetType",
":targetKey",
"from",
":sourceType"
],
"query": [
{
"key": "sourceStatus",
"value": "<string>"
},
{
"key": "targetStatus",
"value": "<string>"
},
{
"key": "sourceVersion",
"value": "<integer>"
},
{
"key": "targetVersion",
"value": "<integer>"
},
{
"key": "expand",
"value": "<string>"
},
{
"key": "expand",
"value": "<string>"
},
{
"key": "start",
"value": "0"
},
{
"key": "limit",
"value": "25"
}
],
"variable": [
{
"key": "relationName"
},
{
"key": "targetType"
},
{
"key": "targetKey"
},
{
"key": "sourceType"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"results\": [\n {\n \"name\": \"eiusmod sunt laboris\",\n \"_expandable\": {\n \"relationData\": \"velit veniam\",\n \"source\": \"eiusmod\",\n \"target\": \"ea consectetur cupidatat ad adipisicing\"\n },\n \"_links\": {},\n \"relationData\": {\n \"createdBy\": {\n \"type\": \"user\",\n \"accountId\": \"velit in exercitation laboris\",\n \"accountType\": \"atlassian\",\n \"email\": \"id voluptate\",\n \"publicName\": \"deserunt\",\n \"profilePicture\": {\n \"path\": \"ut fugiat\",\n \"width\": -38683687,\n \"height\": 65248683,\n \"isDefault\": true\n },\n \"displayName\": \"velit commodo ullamco ipsum\",\n \"_expandable\": {\n \"operations\": \"id veniam\",\n \"details\": \"pariatur\",\n \"personalSpace\": \"enim nostrud exercitation consequat\"\n },\n \"_links\": {},\n \"username\": \"sed ullamco\",\n \"userKey\": \"esse quis elit\",\n \"operations\": [\n {\n \"operation\": \"read\",\n \"targetType\": \"attachment\"\n },\n {\n \"operation\": \"read\",\n \"targetType\": \"page\"\n }\n ],\n \"details\": {\n \"business\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"personal\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"personalSpace\": {\n \"id\": -57606158,\n \"key\": \"sunt cillum aute\",\n \"name\": \"dolore elit ea in\",\n \"type\": \"non in\",\n \"status\": \"aliquip et anim\",\n \"_expandable\": {\n \"settings\": \"ex dolor deserunt anim\",\n \"metadata\": \"dolore qui officia Duis\",\n \"operations\": \"sed laboris\",\n \"lookAndFeel\": \"Duis elit dolore veniam\",\n \"permissions\": \"dolor dolore in\",\n \"icon\": \"reprehenderit pariatur magna labore irure\",\n \"description\": \"Duis aute est fugiat laborum\",\n \"theme\": \"qui nulla est\",\n \"history\": \"non fugiat do\",\n \"homepage\": \"nisi\"\n },\n \"_links\": {},\n \"icon\": {\n \"path\": \"est labore\",\n \"width\": -327281,\n \"height\": -79671930,\n \"isDefault\": false\n },\n \"description\": {\n \"plain\": {\n \"value\": \"esse dolore\",\n \"representation\": \"view\",\n \"embeddedContent\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ]\n },\n \"view\": {\n \"value\": \"commodo\",\n \"representation\": \"view\",\n \"embeddedContent\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ]\n }\n },\n \"homepage\": {\n \"value\": \"<Circular reference to #/components/schemas/Content detected>\"\n },\n \"metadata\": {\n \"labels\": {\n \"results\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ],\n \"start\": -56637757,\n \"limit\": 1062771,\n \"size\": 37957067,\n \"_links\": {}\n }\n },\n \"operations\": [\n {\n \"operation\": \"update\",\n \"targetType\": \"page\"\n },\n {\n \"operation\": \"move\",\n \"targetType\": \"attachment\"\n }\n ],\n \"permissions\": [\n {\n \"subjects\": {\n \"_expandable\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"user\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"group\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"operation\": {\n \"operation\": \"purge_version\",\n \"targetType\": \"page\"\n },\n \"anonymousAccess\": false,\n \"unlicensedAccess\": false\n },\n {\n \"subjects\": {\n \"_expandable\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"user\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"group\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"operation\": {\n \"operation\": \"purge\",\n \"targetType\": \"page\"\n },\n \"anonymousAccess\": false,\n \"unlicensedAccess\": false\n }\n ],\n \"settings\": {\n \"routeOverrideEnabled\": true,\n \"_links\": {}\n },\n \"theme\": {},\n \"lookAndFeel\": {\n \"headings\": {\n \"color\": \"se\"\n },\n \"links\": {\n \"color\": \"sit\"\n },\n \"menus\": {\n \"hoverOrFocus\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"color\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"header\": {\n \"backgroundColor\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"button\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"primaryNavigation\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"secondaryNavigation\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"search\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"content\": {\n \"screen\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"container\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"header\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"body\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"bordersAndDividers\": {\n \"color\": \"magna consequat\"\n }\n },\n \"history\": {\n \"createdDate\": \"1951-04-28T13:26:19.420Z\"\n }\n }\n },\n \"createdDate\": \"1945-06-14T04:34:24.316Z\",\n \"friendlyCreatedDate\": \"reprehenderit \"\n },\n \"source\": {},\n \"target\": {}\n },\n {\n \"name\": \"consectetur Ut enim occaec\",\n \"_expandable\": {\n \"relationData\": \"in est qui\",\n \"source\": \"incididunt\",\n \"target\": \"laborum magna proident amet aliquip\"\n },\n \"_links\": {},\n \"relationData\": {\n \"createdBy\": {\n \"type\": \"user\",\n \"accountId\": \"cillu\",\n \"accountType\": \"app (if this user is a bot user created on behalf of an Atlassian app)\",\n \"email\": \"enim eu\",\n \"publicName\": \"eu aute in\",\n \"profilePicture\": {\n \"path\": \"non\",\n \"width\": -48499479,\n \"height\": 87770702,\n \"isDefault\": true\n },\n \"displayName\": \"dolore ut\",\n \"_expandable\": {\n \"operations\": \"magna pariatur eiusmod nisi\",\n \"details\": \"non consectetur\",\n \"personalSpace\": \"nostrud\"\n },\n \"_links\": {},\n \"username\": \"anim aliquip eu amet\",\n \"userKey\": \"dolore ullamco nostrud laboris\",\n \"operations\": [\n {\n \"operation\": \"administer\",\n \"targetType\": \"comment\"\n },\n {\n \"operation\": \"export\",\n \"targetType\": \"space\"\n }\n ],\n \"details\": {\n \"business\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"personal\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"personalSpace\": {\n \"id\": 96005227,\n \"key\": \"elit eiusmod ad\",\n \"name\": \"in tempor ad\",\n \"type\": \"et elit officia\",\n \"status\": \"dolore\",\n \"_expandable\": {\n \"settings\": \"ad aliquip nisi sed\",\n \"metadata\": \"ut cupidatat\",\n \"operations\": \"veniam sit\",\n \"lookAndFeel\": \"anim ex\",\n \"permissions\": \"mollit qui Lorem nulla quis\",\n \"icon\": \"amet fugiat dolor cupidatat\",\n \"description\": \"consequat anim\",\n \"theme\": \"ipsum\",\n \"history\": \"aliqua Dui\",\n \"homepage\": \"voluptate consectetur do Ut ut\"\n },\n \"_links\": {},\n \"icon\": {\n \"path\": \"ex minim consectetur\",\n \"width\": -35571565,\n \"height\": -58278363,\n \"isDefault\": false\n },\n \"description\": {\n \"plain\": {\n \"value\": \"dolor exercitation\",\n \"representation\": \"plain\",\n \"embeddedContent\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ]\n },\n \"view\": {\n \"value\": \"velit irure laborum id nostrud\",\n \"representation\": \"view\",\n \"embeddedContent\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ]\n }\n },\n \"homepage\": {\n \"value\": \"<Circular reference to #/components/schemas/Content detected>\"\n },\n \"metadata\": {\n \"labels\": {\n \"results\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ],\n \"start\": 36294069,\n \"limit\": -28282967,\n \"size\": 56940014,\n \"_links\": {}\n }\n },\n \"operations\": [\n {\n \"operation\": \"administer\",\n \"targetType\": \"blogpost\"\n },\n {\n \"operation\": \"read\",\n \"targetType\": \"application\"\n }\n ],\n \"permissions\": [\n {\n \"subjects\": {\n \"_expandable\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"user\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"group\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"operation\": {\n \"operation\": \"purge\",\n \"targetType\": \"attachment\"\n },\n \"anonymousAccess\": false,\n \"unlicensedAccess\": false\n },\n {\n \"subjects\": {\n \"_expandable\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"user\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"group\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"operation\": {\n \"operation\": \"create\",\n \"targetType\": \"space\"\n },\n \"anonymousAccess\": false,\n \"unlicensedAccess\": false\n }\n ],\n \"settings\": {\n \"routeOverrideEnabled\": false,\n \"_links\": {}\n },\n \"theme\": {},\n \"lookAndFeel\": {\n \"headings\": {\n \"color\": \"dolore consequat occaeca\"\n },\n \"links\": {\n \"color\": \"occaecat ut sit\"\n },\n \"menus\": {\n \"hoverOrFocus\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"color\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"header\": {\n \"backgroundColor\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"button\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"primaryNavigation\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"secondaryNavigation\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"search\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"content\": {\n \"screen\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"container\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"header\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"body\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"bordersAndDividers\": {\n \"color\": \"deserunt Duis laborum ad\"\n }\n },\n \"history\": {\n \"createdDate\": \"1977-01-29T01:15:06.769Z\"\n }\n }\n },\n \"createdDate\": \"2018-11-14T12:56:13.456Z\",\n \"friendlyCreatedDate\": \"reprehenderit laborum\"\n },\n \"source\": {},\n \"target\": {}\n }\n ],\n \"start\": -48357202,\n \"limit\": 5335291,\n \"size\": 43833338,\n \"_links\": {}\n}"
},
{
"name": "Returned if the user does not have permission to view the\nrelationship",
"originalRequest": {
"method": "GET",
"header": [
{
"description": {
"content": "Added as a part of security scheme: oauth2",
"type": "text/plain"
},
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/api/relation/:relationName/to/:targetType/:targetKey/from/:sourceType?sourceStatus=<string>&targetStatus=<string>&sourceVersion=<integer>&targetVersion=<integer>&expand=<string>&expand=<string>&start=0&limit=25",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"relation",
":relationName",
"to",
":targetType",
":targetKey",
"from",
":sourceType"
],
"query": [
{
"key": "sourceStatus",
"value": "<string>"
},
{
"key": "targetStatus",
"value": "<string>"
},
{
"key": "sourceVersion",
"value": "<integer>"
},
{
"key": "targetVersion",
"value": "<integer>"
},
{
"key": "expand",
"value": "<string>"
},
{
"key": "expand",
"value": "<string>"
},
{
"key": "start",
"value": "0"
},
{
"key": "limit",
"value": "25"
}
],
"variable": [
{
"key": "relationName"
},
{
"key": "targetType"
},
{
"key": "targetKey"
},
{
"key": "sourceType"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "Returned if the target entity does not exist.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": {
"content": "Added as a part of security scheme: oauth2",
"type": "text/plain"
},
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/api/relation/:relationName/to/:targetType/:targetKey/from/:sourceType?sourceStatus=<string>&targetStatus=<string>&sourceVersion=<integer>&targetVersion=<integer>&expand=<string>&expand=<string>&start=0&limit=25",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"relation",
":relationName",
"to",
":targetType",
":targetKey",
"from",
":sourceType"
],
"query": [
{
"key": "sourceStatus",
"value": "<string>"
},
{
"key": "targetStatus",
"value": "<string>"
},
{
"key": "sourceVersion",
"value": "<integer>"
},
{
"key": "targetVersion",
"value": "<integer>"
},
{
"key": "expand",
"value": "<string>"
},
{
"key": "expand",
"value": "<string>"
},
{
"key": "start",
"value": "0"
},
{
"key": "limit",
"value": "25"
}
],
"variable": [
{
"key": "relationName"
},
{
"key": "targetType"
},
{
"key": "targetKey"
},
{
"key": "sourceType"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
