Chilkat Online Tools

phpExt / Atlassian Confluence Cloud / Add labels to content

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

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

$http = new CkHttp();

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

$jarr = new CkJsonArray();

$jarr->AddObjectAt(-1);
// jsonObj_1 is a CkJsonObject
$jsonObj_1 = $jarr->ObjectAt($jarr->get_Size() - 1);
$jsonObj_1->UpdateString('prefix','<string>');
$jsonObj_1->UpdateString('name','<string>');

$jarr->AddObjectAt(-1);
// jsonObj_1 is a CkJsonObject
$jsonObj_1 = $jarr->ObjectAt($jarr->get_Size() - 1);
$jsonObj_1->UpdateString('prefix','<string>');
$jsonObj_1->UpdateString('name','<string>');

// Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken('<access_token>');
$http->SetRequestHeader('Content-Type','application/json');

$sbRequestBody = new CkStringBuilder();
$jarr->EmitSb($sbRequestBody);

// resp is a CkHttpResponse
$resp = $http->PTextSb('POST','https://your-domain.atlassian.net/wiki/rest/api/content/:id/label',$sbRequestBody,'utf-8','application/json',false,false);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);

$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->header() . "\n";
    print 'Failed.' . "\n";

    exit;
}

// 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

$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);
    $prefix = $jResp->stringOf('results[i].prefix');
    $name = $jResp->stringOf('results[i].name');
    $id = $jResp->stringOf('results[i].id');
    $label = $jResp->stringOf('results[i].label');
    $i = $i + 1;
}


?>

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