Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJarr
LOCAL loJsonObj_1
LOCAL loSbRequestBody
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcPrefix
LOCAL lcName
LOCAL lcId
LOCAL lcLabel
LOCAL lnStart
LOCAL lnLimit
LOCAL lnSize
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* Use this online tool to generate code from sample JSON: Generate Code to Create JSON
* The following JSON is sent in the request body.
* [
* {
* "prefix": "<string>",
* "name": "<string>"
* },
* {
* "prefix": "<string>",
* "name": "<string>"
* }
* ]
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonArray')
loJarr = CreateObject('Chilkat.JsonArray')
loJarr.AddObjectAt(-1)
loJsonObj_1 = loJarr.ObjectAt(loJarr.Size - 1)
loJsonObj_1.UpdateString("prefix","<string>")
loJsonObj_1.UpdateString("name","<string>")
RELEASE loJsonObj_1
loJarr.AddObjectAt(-1)
loJsonObj_1 = loJarr.ObjectAt(loJarr.Size - 1)
loJsonObj_1.UpdateString("prefix","<string>")
loJsonObj_1.UpdateString("name","<string>")
RELEASE loJsonObj_1
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Content-Type","application/json")
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbRequestBody = CreateObject('Chilkat.StringBuilder')
loJarr.EmitSb(loSbRequestBody)
loResp = loHttp.PTextSb("POST","https://your-domain.atlassian.net/wiki/rest/api/content/:id/label",loSbRequestBody,"utf-8","application/json",0,0)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJarr
RELEASE loSbRequestBody
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loJarr
RELEASE loSbRequestBody
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)
* {
* "results": [
* {
* "prefix": "Duis elit dolor officia",
* "name": "non sunt",
* "id": "nulla veniam",
* "label": "deserunt Ut Excepteur magna"
* },
* {
* "prefix": "in consequat deserun",
* "name": "officia cillum enim",
* "id": "Lorem quis esse amet",
* "label": "dolore esse"
* }
* ],
* "start": -32316568,
* "limit": -3993073,
* "size": -78086889,
* "_links": {}
* }
* Sample code for parsing the JSON response...
* Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lnStart = loJResp.IntOf("start")
lnLimit = loJResp.IntOf("limit")
lnSize = loJResp.IntOf("size")
i = 0
lnCount_i = loJResp.SizeOfArray("results")
DO WHILE i < lnCount_i
loJResp.I = i
lcPrefix = loJResp.StringOf("results[i].prefix")
lcName = loJResp.StringOf("results[i].name")
lcId = loJResp.StringOf("results[i].id")
lcLabel = loJResp.StringOf("results[i].label")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loJarr
RELEASE loSbRequestBody
RELEASE loSbResponseBody
RELEASE loJResp
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '[
{
"prefix": "<string>",
"name": "<string>"
},
{
"prefix": "<string>",
"name": "<string>"
}
]'
https://your-domain.atlassian.net/wiki/rest/api/content/:id/label
Postman Collection Item JSON
{
"name": "Add labels to content",
"request": {
"auth": {
"type": "oauth2"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "[\n {\n \"prefix\": \"<string>\",\n \"name\": \"<string>\"\n },\n {\n \"prefix\": \"<string>\",\n \"name\": \"<string>\"\n }\n]"
},
"url": {
"raw": "{{baseUrl}}/api/content/:id/label",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"content",
":id",
"label"
],
"variable": [
{
"key": "id",
"value": "<string>",
"type": "string",
"description": "(Required) The ID of the content that will have labels added to it."
}
]
},
"description": "Adds labels to a piece of content. Does not modify the existing labels.\n\nNotes:\n\n- Labels can also be added when creating content ([Create content](#api-content-post)).\n- Labels can be updated when updating content ([Update content](#api-content-id-put)).\nThis will delete the existing labels and replace them with the labels in\nthe request.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to update the content."
},
"response": [
{
"name": "Returned if the labels are added to the content.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": {
"content": "Added as a part of security scheme: oauth2",
"type": "text/plain"
},
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "raw",
"raw": "[\n {\n \"prefix\": \"<string>\",\n \"name\": \"<string>\"\n },\n {\n \"prefix\": \"<string>\",\n \"name\": \"<string>\"\n }\n]"
},
"url": {
"raw": "{{baseUrl}}/api/content/:id/label",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"content",
":id",
"label"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"results\": [\n {\n \"prefix\": \"Duis elit dolor officia\",\n \"name\": \"non sunt\",\n \"id\": \"nulla veniam\",\n \"label\": \"deserunt Ut Excepteur magna\"\n },\n {\n \"prefix\": \"in consequat deserun\",\n \"name\": \"officia cillum enim\",\n \"id\": \"Lorem quis esse amet\",\n \"label\": \"dolore esse\"\n }\n ],\n \"start\": -32316568,\n \"limit\": -3993073,\n \"size\": -78086889,\n \"_links\": {}\n}"
},
{
"name": "Returned if;\n\n- There is no content with the given ID.\n- The calling user does not have permission to view the content.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": {
"content": "Added as a part of security scheme: oauth2",
"type": "text/plain"
},
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "raw",
"raw": "[\n {\n \"prefix\": \"<string>\",\n \"name\": \"<string>\"\n },\n {\n \"prefix\": \"<string>\",\n \"name\": \"<string>\"\n }\n]"
},
"url": {
"raw": "{{baseUrl}}/api/content/:id/label",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"content",
":id",
"label"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
