Chilkat Online Tools

autoit / Atlassian Confluence Cloud / Add labels to content

Back to Collection Items

; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

; 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>"
;   }
; ]

$oJarr = ObjCreate("Chilkat.JsonArray")

$oJarr.AddObjectAt(-1)
Local $oJsonObj_1 = $oJarr.ObjectAt($oJarr.Size - 1)
$oJsonObj_1.UpdateString("prefix","<string>")
$oJsonObj_1.UpdateString("name","<string>")

$oJarr.AddObjectAt(-1)
$oJsonObj_1 = $oJarr.ObjectAt($oJarr.Size - 1)
$oJsonObj_1.UpdateString("prefix","<string>")
$oJsonObj_1.UpdateString("name","<string>")

; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oHttp.SetRequestHeader "Content-Type","application/json"

$oSbRequestBody = ObjCreate("Chilkat.StringBuilder")
$oJarr.EmitSb($oSbRequestBody)

Local $oResp = $oHttp.PTextSb("POST","https://your-domain.atlassian.net/wiki/rest/api/content/:id/label",$oSbRequestBody,"utf-8","application/json",False,False)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

; 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

Local $sPrefix
Local $sName
Local $sId
Local $sLabel

Local $iStart = $oJResp.IntOf("start")
Local $iLimit = $oJResp.IntOf("limit")
Local $iSize = $oJResp.IntOf("size")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("results")
While $i < $iCount_i
    $oJResp.I = $i
    $sPrefix = $oJResp.StringOf("results[i].prefix")
    $sName = $oJResp.StringOf("results[i].name")
    $sId = $oJResp.StringOf("results[i].id")
    $sLabel = $oJResp.StringOf("results[i].label")
    $i = $i + 1
Wend

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": ""
    }
  ]
}