Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonObjectW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *operation;
const wchar_t *targetType;
const wchar_t *value;
const wchar_t *v_expandableValue;
const wchar_t *UserValue;
const wchar_t *GroupValue;
const wchar_t *Operation;
const wchar_t *TargetType;
BOOL anonymousAccess;
BOOL unlicensedAccess;
const wchar_t *name;
const wchar_t *RelationData;
const wchar_t *Source;
const wchar_t *Target;
const wchar_t *v_Type;
const wchar_t *AccountId;
const wchar_t *AccountType;
const wchar_t *v_Email;
const wchar_t *PublicName;
const wchar_t *Path;
int Width;
int Height;
BOOL IsDefault;
const wchar_t *DisplayName;
const wchar_t *Operations;
const wchar_t *Details;
const wchar_t *PersonalSpace;
const wchar_t *Username;
const wchar_t *UserKey;
const wchar_t *Value;
const wchar_t *PersonalValue;
int Id;
const wchar_t *Key;
const wchar_t *Name;
const wchar_t *PersonalSpaceType;
const wchar_t *Status;
const wchar_t *Settings;
const wchar_t *Metadata;
const wchar_t *v_expandableOperations;
const wchar_t *LookAndFeel;
const wchar_t *Permissions;
const wchar_t *Icon;
const wchar_t *Description;
const wchar_t *Theme;
const wchar_t *History;
const wchar_t *Homepage;
const wchar_t *IconPath;
int IconWidth;
int IconHeight;
BOOL IconIsDefault;
const wchar_t *PlainValue;
const wchar_t *Representation;
const wchar_t *ViewValue;
const wchar_t *ViewRepresentation;
const wchar_t *HomepageValue;
int Start;
int Limit;
int Size;
BOOL RouteOverrideEnabled;
const wchar_t *Color;
const wchar_t *LinksColor;
const wchar_t *HoverOrFocusValue;
const wchar_t *ColorValue;
const wchar_t *BackgroundColorValue;
const wchar_t *ButtonValue;
const wchar_t *PrimaryNavigationValue;
const wchar_t *SecondaryNavigationValue;
const wchar_t *SearchValue;
const wchar_t *ScreenValue;
const wchar_t *ContainerValue;
const wchar_t *HeaderValue;
const wchar_t *BodyValue;
const wchar_t *BordersAndDividersColor;
const wchar_t *CreatedDate;
const wchar_t *relationDataCreatedDate;
const wchar_t *FriendlyCreatedDate;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
// Adds the "Authorization: Bearer <access_token>" header.
CkHttpW_putAuthToken(http,L"<access_token>");
resp = CkHttpW_QuickRequest(http,L"PUT",L"https://your-domain.atlassian.net/wiki/rest/api/relation/:relationName/from/:sourceType/:sourceKey/to/:targetType/:targetKey?sourceStatus=<string>&targetStatus=<string>&sourceVersion=<integer>&targetVersion=<integer>");
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "name": "laborum amet",
// "_expandable": {
// "relationData": "minim do quis",
// "source": "quis velit dolore ut",
// "target": "sint fugiat id repreh"
// },
// "_links": {},
// "relationData": {
// "createdBy": {
// "type": "known",
// "accountId": "est veniam nisi",
// "accountType": "atlassian",
// "email": "fugiat tempor est",
// "publicName": "proident cillum adipisicing",
// "profilePicture": {
// "path": "incididunt dolore sit in eu",
// "width": 66665902,
// "height": 7198703,
// "isDefault": false
// },
// "displayName": "mollit ex pariatur dolor",
// "_expandable": {
// "operations": "adipisicing in",
// "details": "id minim sed",
// "personalSpace": "Ut"
// },
// "_links": {},
// "username": "proident ut incididunt consequat",
// "userKey": "ipsum consequat sed ullamco aliquip",
// "operations": [
// {
// "operation": "copy",
// "targetType": "space"
// },
// {
// "operation": "purge_version",
// "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": 32251017,
// "key": "Excepteur do",
// "name": "est velit non",
// "type": "deserunt occaecat",
// "status": "in commodo incididunt non",
// "_expandable": {
// "settings": "ut cillum quis in",
// "metadata": "dolore minim",
// "operations": "anim commodo amet",
// "lookAndFeel": "dolore Lorem",
// "permissions": "dolore anim",
// "icon": "deserunt ex occaecat amet",
// "description": "cillum nostrud sint",
// "theme": "dolor id",
// "history": "in fugiat eu esse",
// "homepage": "et"
// },
// "_links": {},
// "icon": {
// "path": "laboris eiusmod Excepteur eu",
// "width": -89581460,
// "height": -66835718,
// "isDefault": true
// },
// "description": {
// "plain": {
// "value": "ut eu reprehenderit",
// "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": "reprehenderit",
// "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": 83305188,
// "limit": 81363289,
// "size": -91970205,
// "_links": {}
// }
// },
// "operations": [
// {
// "operation": "purge",
// "targetType": "comment"
// },
// {
// "operation": "use",
// "targetType": "blogpost"
// }
// ],
// "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": "administer",
// "targetType": "blogpost"
// },
// "anonymousAccess": false,
// "unlicensedAccess": false
// }
// ],
// "settings": {
// "routeOverrideEnabled": true,
// "_links": {}
// },
// "theme": {},
// "lookAndFeel": {
// "headings": {
// "color": "fugiat irure nostrud"
// },
// "links": {
// "color": "ad velit"
// },
// "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": "do in laborum"
// }
// },
// "history": {
// "createdDate": "1968-05-01T03:07:38.118Z"
// }
// }
// },
// "createdDate": "1955-09-27T16:15:59.770Z",
// "friendlyCreatedDate": "reprehenderit quis"
// },
// "source": {},
// "target": {}
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
name = CkJsonObjectW_stringOf(jResp,L"name");
RelationData = CkJsonObjectW_stringOf(jResp,L"_expandable.relationData");
Source = CkJsonObjectW_stringOf(jResp,L"_expandable.source");
Target = CkJsonObjectW_stringOf(jResp,L"_expandable.target");
v_Type = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.type");
AccountId = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.accountId");
AccountType = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.accountType");
v_Email = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.email");
PublicName = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.publicName");
Path = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.profilePicture.path");
Width = CkJsonObjectW_IntOf(jResp,L"relationData.createdBy.profilePicture.width");
Height = CkJsonObjectW_IntOf(jResp,L"relationData.createdBy.profilePicture.height");
IsDefault = CkJsonObjectW_BoolOf(jResp,L"relationData.createdBy.profilePicture.isDefault");
DisplayName = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.displayName");
Operations = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy._expandable.operations");
Details = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy._expandable.details");
PersonalSpace = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy._expandable.personalSpace");
Username = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.username");
UserKey = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.userKey");
Value = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.details.business.value");
PersonalValue = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.details.personal.value");
Id = CkJsonObjectW_IntOf(jResp,L"relationData.createdBy.personalSpace.id");
Key = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.key");
Name = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.name");
PersonalSpaceType = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.type");
Status = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.status");
Settings = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace._expandable.settings");
Metadata = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace._expandable.metadata");
v_expandableOperations = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace._expandable.operations");
LookAndFeel = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace._expandable.lookAndFeel");
Permissions = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace._expandable.permissions");
Icon = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace._expandable.icon");
Description = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace._expandable.description");
Theme = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace._expandable.theme");
History = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace._expandable.history");
Homepage = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace._expandable.homepage");
IconPath = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.icon.path");
IconWidth = CkJsonObjectW_IntOf(jResp,L"relationData.createdBy.personalSpace.icon.width");
IconHeight = CkJsonObjectW_IntOf(jResp,L"relationData.createdBy.personalSpace.icon.height");
IconIsDefault = CkJsonObjectW_BoolOf(jResp,L"relationData.createdBy.personalSpace.icon.isDefault");
PlainValue = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.description.plain.value");
Representation = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.description.plain.representation");
ViewValue = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.description.view.value");
ViewRepresentation = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.description.view.representation");
HomepageValue = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.homepage.value");
Start = CkJsonObjectW_IntOf(jResp,L"relationData.createdBy.personalSpace.metadata.labels.start");
Limit = CkJsonObjectW_IntOf(jResp,L"relationData.createdBy.personalSpace.metadata.labels.limit");
Size = CkJsonObjectW_IntOf(jResp,L"relationData.createdBy.personalSpace.metadata.labels.size");
RouteOverrideEnabled = CkJsonObjectW_BoolOf(jResp,L"relationData.createdBy.personalSpace.settings.routeOverrideEnabled");
Color = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.lookAndFeel.headings.color");
LinksColor = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.lookAndFeel.links.color");
HoverOrFocusValue = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.lookAndFeel.menus.hoverOrFocus.value");
ColorValue = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.lookAndFeel.menus.color.value");
BackgroundColorValue = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.lookAndFeel.header.backgroundColor.value");
ButtonValue = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.lookAndFeel.header.button.value");
PrimaryNavigationValue = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.lookAndFeel.header.primaryNavigation.value");
SecondaryNavigationValue = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.lookAndFeel.header.secondaryNavigation.value");
SearchValue = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.lookAndFeel.header.search.value");
ScreenValue = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.lookAndFeel.content.screen.value");
ContainerValue = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.lookAndFeel.content.container.value");
HeaderValue = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.lookAndFeel.content.header.value");
BodyValue = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.lookAndFeel.content.body.value");
BordersAndDividersColor = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.lookAndFeel.bordersAndDividers.color");
CreatedDate = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.history.createdDate");
relationDataCreatedDate = CkJsonObjectW_stringOf(jResp,L"relationData.createdDate");
FriendlyCreatedDate = CkJsonObjectW_stringOf(jResp,L"relationData.friendlyCreatedDate");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"relationData.createdBy.operations");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
operation = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.operations[i].operation");
targetType = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.operations[i].targetType");
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"relationData.createdBy.personalSpace.description.plain.embeddedContent");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
value = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.description.plain.embeddedContent[i].value");
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"relationData.createdBy.personalSpace.description.view.embeddedContent");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
value = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.description.view.embeddedContent[i].value");
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"relationData.createdBy.personalSpace.metadata.labels.results");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
value = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.metadata.labels.results[i].value");
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"relationData.createdBy.personalSpace.operations");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
operation = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.operations[i].operation");
targetType = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.operations[i].targetType");
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"relationData.createdBy.personalSpace.permissions");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
v_expandableValue = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.permissions[i].subjects._expandable.value");
UserValue = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.permissions[i].subjects.user.value");
GroupValue = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.permissions[i].subjects.group.value");
Operation = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.permissions[i].operation.operation");
TargetType = CkJsonObjectW_stringOf(jResp,L"relationData.createdBy.personalSpace.permissions[i].operation.targetType");
anonymousAccess = CkJsonObjectW_BoolOf(jResp,L"relationData.createdBy.personalSpace.permissions[i].anonymousAccess");
unlicensedAccess = CkJsonObjectW_BoolOf(jResp,L"relationData.createdBy.personalSpace.permissions[i].unlicensedAccess");
i = i + 1;
}
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
https://your-domain.atlassian.net/wiki/rest/api/relation/:relationName/from/:sourceType/:sourceKey/to/:targetType/:targetKey?sourceStatus=<string>&targetStatus=<string>&sourceVersion=<integer>&targetVersion=<integer>
Postman Collection Item JSON
{
"name": "Create relationship",
"request": {
"auth": {
"type": "oauth2"
},
"method": "PUT",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/relation/:relationName/from/:sourceType/:sourceKey/to/:targetType/:targetKey?sourceStatus=<string>&targetStatus=<string>&sourceVersion=<integer>&targetVersion=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"relation",
":relationName",
"from",
":sourceType",
":sourceKey",
"to",
":targetType",
":targetKey"
],
"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'."
}
],
"variable": [
{
"key": "relationName",
"value": "<string>",
"type": "string",
"description": "(Required) The name of the relationship. This method supports the 'favourite'\n(i.e. 'save for later') relationship. You can also specify any other\nvalue for this parameter to create a custom relationship type."
},
{
"key": "sourceType",
"value": "<string>",
"type": "string",
"description": "(Required) The source entity type of the relationship. This must be 'user', if\nthe `relationName` is 'favourite'."
},
{
"key": "sourceKey",
"value": "<string>",
"type": "string",
"description": "(Required) - The identifier for the source entity:\n\n- If `sourceType` is 'user', then specify either 'current' (logged-in\n user) or the user key.\n- If `sourceType` is 'content', then specify the content ID.\n- If `sourceType` is 'space', then specify the space key."
},
{
"key": "targetType",
"value": "<string>",
"type": "string",
"description": "(Required) The target entity type of the relationship. This must be 'space' or\n'content', if the `relationName` is 'favourite'."
},
{
"key": "targetKey",
"value": "<string>",
"type": "string",
"description": "(Required) - The identifier for the target entity:\n\n- If `sourceType` is 'user', then specify either 'current' (logged-in\n user) or the user key.\n- If `sourceType` is 'content', then specify the content ID.\n- If `sourceType` is 'space', then specify the space key."
}
]
},
"description": "Creates a relationship between two entities (user, space, content). The\n'favourite' relationship is supported by default, but you can use this method\nto create any type of relationship between two entities.\n\nFor example, the following method creates a 'sibling' relationship between\ntwo pieces of content:\n`GET https://your-domain.atlassian.net/wiki/rest/api/relation/sibling/from/content/123/to/content/456`\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission)."
},
"response": [
{
"name": "Returned if the relationship is created.",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": {
"content": "Added as a part of security scheme: oauth2",
"type": "text/plain"
},
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/api/relation/:relationName/from/:sourceType/:sourceKey/to/:targetType/:targetKey?sourceStatus=<string>&targetStatus=<string>&sourceVersion=<integer>&targetVersion=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"relation",
":relationName",
"from",
":sourceType",
":sourceKey",
"to",
":targetType",
":targetKey"
],
"query": [
{
"key": "sourceStatus",
"value": "<string>"
},
{
"key": "targetStatus",
"value": "<string>"
},
{
"key": "sourceVersion",
"value": "<integer>"
},
{
"key": "targetVersion",
"value": "<integer>"
}
],
"variable": [
{
"key": "relationName"
},
{
"key": "sourceType"
},
{
"key": "sourceKey"
},
{
"key": "targetType"
},
{
"key": "targetKey"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"name\": \"laborum amet\",\n \"_expandable\": {\n \"relationData\": \"minim do quis\",\n \"source\": \"quis velit dolore ut\",\n \"target\": \"sint fugiat id repreh\"\n },\n \"_links\": {},\n \"relationData\": {\n \"createdBy\": {\n \"type\": \"known\",\n \"accountId\": \"est veniam nisi\",\n \"accountType\": \"atlassian\",\n \"email\": \"fugiat tempor est\",\n \"publicName\": \"proident cillum adipisicing\",\n \"profilePicture\": {\n \"path\": \"incididunt dolore sit in eu\",\n \"width\": 66665902,\n \"height\": 7198703,\n \"isDefault\": false\n },\n \"displayName\": \"mollit ex pariatur dolor\",\n \"_expandable\": {\n \"operations\": \"adipisicing in\",\n \"details\": \"id minim sed\",\n \"personalSpace\": \"Ut\"\n },\n \"_links\": {},\n \"username\": \"proident ut incididunt consequat\",\n \"userKey\": \"ipsum consequat sed ullamco aliquip\",\n \"operations\": [\n {\n \"operation\": \"copy\",\n \"targetType\": \"space\"\n },\n {\n \"operation\": \"purge_version\",\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\": 32251017,\n \"key\": \"Excepteur do\",\n \"name\": \"est velit non\",\n \"type\": \"deserunt occaecat\",\n \"status\": \"in commodo incididunt non\",\n \"_expandable\": {\n \"settings\": \"ut cillum quis in\",\n \"metadata\": \"dolore minim\",\n \"operations\": \"anim commodo amet\",\n \"lookAndFeel\": \"dolore Lorem\",\n \"permissions\": \"dolore anim\",\n \"icon\": \"deserunt ex occaecat amet\",\n \"description\": \"cillum nostrud sint\",\n \"theme\": \"dolor id\",\n \"history\": \"in fugiat eu esse\",\n \"homepage\": \"et\"\n },\n \"_links\": {},\n \"icon\": {\n \"path\": \"laboris eiusmod Excepteur eu\",\n \"width\": -89581460,\n \"height\": -66835718,\n \"isDefault\": true\n },\n \"description\": {\n \"plain\": {\n \"value\": \"ut eu reprehenderit\",\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\": \"reprehenderit\",\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\": 83305188,\n \"limit\": 81363289,\n \"size\": -91970205,\n \"_links\": {}\n }\n },\n \"operations\": [\n {\n \"operation\": \"purge\",\n \"targetType\": \"comment\"\n },\n {\n \"operation\": \"use\",\n \"targetType\": \"blogpost\"\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\": \"administer\",\n \"targetType\": \"blogpost\"\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\": \"fugiat irure nostrud\"\n },\n \"links\": {\n \"color\": \"ad velit\"\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\": \"do in laborum\"\n }\n },\n \"history\": {\n \"createdDate\": \"1968-05-01T03:07:38.118Z\"\n }\n }\n },\n \"createdDate\": \"1955-09-27T16:15:59.770Z\",\n \"friendlyCreatedDate\": \"reprehenderit quis\"\n },\n \"source\": {},\n \"target\": {}\n}"
},
{
"name": "Returned if the user does not have permission to use Confluence.",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": {
"content": "Added as a part of security scheme: oauth2",
"type": "text/plain"
},
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/api/relation/:relationName/from/:sourceType/:sourceKey/to/:targetType/:targetKey?sourceStatus=<string>&targetStatus=<string>&sourceVersion=<integer>&targetVersion=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"relation",
":relationName",
"from",
":sourceType",
":sourceKey",
"to",
":targetType",
":targetKey"
],
"query": [
{
"key": "sourceStatus",
"value": "<string>"
},
{
"key": "targetStatus",
"value": "<string>"
},
{
"key": "sourceVersion",
"value": "<integer>"
},
{
"key": "targetVersion",
"value": "<integer>"
}
],
"variable": [
{
"key": "relationName"
},
{
"key": "sourceType"
},
{
"key": "sourceKey"
},
{
"key": "targetType"
},
{
"key": "targetKey"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "Returned if the user, space or content could not be found.",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": {
"content": "Added as a part of security scheme: oauth2",
"type": "text/plain"
},
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/api/relation/:relationName/from/:sourceType/:sourceKey/to/:targetType/:targetKey?sourceStatus=<string>&targetStatus=<string>&sourceVersion=<integer>&targetVersion=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"relation",
":relationName",
"from",
":sourceType",
":sourceKey",
"to",
":targetType",
":targetKey"
],
"query": [
{
"key": "sourceStatus",
"value": "<string>"
},
{
"key": "targetStatus",
"value": "<string>"
},
{
"key": "sourceVersion",
"value": "<integer>"
},
{
"key": "targetVersion",
"value": "<integer>"
}
],
"variable": [
{
"key": "relationName"
},
{
"key": "sourceType"
},
{
"key": "sourceKey"
},
{
"key": "targetType"
},
{
"key": "targetKey"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
