Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global_Ref.html">Global_Ref.html">Global_Ref.html">Global_Ref.html">Global_Ref.html">Global_Ref.html">Global_Ref.html">Global Unlock Sample for sample code.
http := Http_Ref.html">Http_Ref.html">Http_Ref.html">Http_Ref.html">Http_Ref.html">Http_Ref.html">Http_Ref.html">chilkat.NewHttp()
var success bool
queryParams := JsonObject_Ref.html">JsonObject_Ref.html">JsonObject_Ref.html">JsonObject_Ref.html">JsonObject_Ref.html">JsonObject_Ref.html">JsonObject_Ref.html">chilkat.NewJsonObject()
queryParams.UpdateString("name","")
queryParams.UpdateString("type","")
queryParams.UpdateInt("start",0)
queryParams.UpdateInt("limit",200)
// Adds the "Authorization: Bearer <access_token>" header.
http.SetAuthToken("<access_token>")
resp := HttpResponse_Ref.html">HttpResponse_Ref.html">HttpResponse_Ref.html">HttpResponse_Ref.html">HttpResponse_Ref.html">HttpResponse_Ref.html">HttpResponse_Ref.html">chilkat.NewHttpResponse()
success = http.HttpParams("GET","https://your-domain.atlassian.net/wiki/rest/api/label",queryParams,resp)
if success == false {
fmt.Println(http.LastErrorText())
http.DisposeHttp()
queryParams.DisposeJsonObject()
resp.DisposeHttpResponse()
return
}
sbResponseBody := StringBuilder_Ref.html">StringBuilder_Ref.html">StringBuilder_Ref.html">StringBuilder_Ref.html">StringBuilder_Ref.html">StringBuilder_Ref.html">StringBuilder_Ref.html">chilkat.NewStringBuilder()
resp.GetBodySb(sbResponseBody)
jResp := JsonObject_Ref.html">JsonObject_Ref.html">JsonObject_Ref.html">JsonObject_Ref.html">JsonObject_Ref.html">JsonObject_Ref.html">JsonObject_Ref.html">chilkat.NewJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.SetEmitCompact(false)
fmt.Println("Response Body:")
fmt.Println(*jResp.Emit())
respStatusCode := resp.StatusCode()
fmt.Println("Response Status Code = ", respStatusCode)
if respStatusCode >= 400 {
fmt.Println("Response Header:")
fmt.Println(resp.Header())
fmt.Println("Failed.")
http.DisposeHttp()
queryParams.DisposeJsonObject()
resp.DisposeHttpResponse()
sbResponseBody.DisposeStringBuilder()
jResp.DisposeJsonObject()
return
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "label": {
// "prefix": "est dolore",
// "name": "elit magna culpa voluptate minim",
// "id": "fugiat in occaecat",
// "label": "Excepteur eu culpa qui non"
// },
// "associatedContents": {
// "results": [
// {
// "contentType": "attachment",
// "contentId": -15123374,
// "title": "est"
// },
// {
// "contentType": "attachment",
// "contentId": 29751066,
// "title": "in fugiat"
// }
// ],
// "size": -57367807,
// "start": 711472,
// "limit": -23936898
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
var contentType *string = new(string)
var contentId int
var title *string = new(string)
Prefix := jResp.StringOf("label.prefix")
Name := jResp.StringOf("label.name")
Id := jResp.StringOf("label.id")
Label := jResp.StringOf("label.label")
Size := jResp.IntOf("associatedContents.size")
Start := jResp.IntOf("associatedContents.start")
Limit := jResp.IntOf("associatedContents.limit")
i := 0
count_i := jResp.SizeOfArray("associatedContents.results")
for i < count_i {
jResp.SetI(i)
contentType = jResp.StringOf("associatedContents.results[i].contentType")
contentId = jResp.IntOf("associatedContents.results[i].contentId")
title = jResp.StringOf("associatedContents.results[i].title")
i = i + 1
}
http.DisposeHttp()
queryParams.DisposeJsonObject()
resp.DisposeHttpResponse()
sbResponseBody.DisposeStringBuilder()
jResp.DisposeJsonObject()
Curl Command
curl -G -d "name="
-d "type="
-d "start=0"
-d "limit=200"
-H "Authorization: Bearer <access_token>"
https://your-domain.atlassian.net/wiki/rest/api/label
Postman Collection Item JSON
{
"name": "Get Label information.",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/label?name=&type=&start=0&limit=200",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"label"
],
"query": [
{
"key": "name",
"value": "",
"description": "(Required) Name of the label to query."
},
{
"key": "type",
"value": "",
"description": "The type of contents that are to be returned."
},
{
"key": "start",
"value": "0",
"description": "The starting offset for the results."
},
{
"key": "limit",
"value": "200",
"description": "The number of results to be returned."
}
]
},
"description": "Returns label information and a list of contents associated with the label.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission). Only contents\nthat the user is permitted to view is returned."
},
"response": [
{
"name": "Returned if the query fetches zero or more results.",
"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/label?name=&type=&start=0&limit=200",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"label"
],
"query": [
{
"key": "name",
"value": ""
},
{
"key": "type",
"value": ""
},
{
"key": "start",
"value": "0"
},
{
"key": "limit",
"value": "200"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"label\": {\n \"prefix\": \"est dolore\",\n \"name\": \"elit magna culpa voluptate minim\",\n \"id\": \"fugiat in occaecat\",\n \"label\": \"Excepteur eu culpa qui non\"\n },\n \"associatedContents\": {\n \"results\": [\n {\n \"contentType\": \"attachment\",\n \"contentId\": -15123374,\n \"title\": \"est\"\n },\n {\n \"contentType\": \"attachment\",\n \"contentId\": 29751066,\n \"title\": \"in fugiat\"\n }\n ],\n \"size\": -57367807,\n \"start\": 711472,\n \"limit\": -23936898\n }\n}"
},
{
"name": "Returned if no label name is provide or\nif content type provided in the query is invalid.",
"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/label?name=&type=&start=0&limit=200",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"label"
],
"query": [
{
"key": "name",
"value": ""
},
{
"key": "type",
"value": ""
},
{
"key": "start",
"value": "0"
},
{
"key": "limit",
"value": "200"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "Returned if the calling user does not have permission to view\nany content including label info.",
"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/label?name=&type=&start=0&limit=200",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"label"
],
"query": [
{
"key": "name",
"value": ""
},
{
"key": "type",
"value": ""
},
{
"key": "start",
"value": "0"
},
{
"key": "limit",
"value": "200"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "Returned if the lable name is invalid or if no label is found for a given label.",
"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/label?name=&type=&start=0&limit=200",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"label"
],
"query": [
{
"key": "name",
"value": ""
},
{
"key": "type",
"value": ""
},
{
"key": "start",
"value": "0"
},
{
"key": "limit",
"value": "200"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
