Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vQueryParams
Handle hoQueryParams
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sContentType
Integer iContentId
String sTitle
String sPrefix
String sName
String sId
String sLabel
Integer iSize
Integer iStart
Integer iLimit
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
If (Not(IsComObjectCreated(hoQueryParams))) Begin
Send CreateComObject of hoQueryParams
End
Get ComUpdateString Of hoQueryParams "name" "" To iSuccess
Get ComUpdateString Of hoQueryParams "type" "" To iSuccess
Get ComUpdateInt Of hoQueryParams "start" 0 To iSuccess
Get ComUpdateInt Of hoQueryParams "limit" 200 To iSuccess
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Get pvComObject of hoQueryParams to vQueryParams
Get ComQuickRequestParams Of hoHttp "GET" "https://your-domain.atlassian.net/wiki/rest/api/label" vQueryParams To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// 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
Get ComStringOf Of hoJResp "label.prefix" To sPrefix
Get ComStringOf Of hoJResp "label.name" To sName
Get ComStringOf Of hoJResp "label.id" To sId
Get ComStringOf Of hoJResp "label.label" To sLabel
Get ComIntOf Of hoJResp "associatedContents.size" To iSize
Get ComIntOf Of hoJResp "associatedContents.start" To iStart
Get ComIntOf Of hoJResp "associatedContents.limit" To iLimit
Move 0 To i
Get ComSizeOfArray Of hoJResp "associatedContents.results" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "associatedContents.results[i].contentType" To sContentType
Get ComIntOf Of hoJResp "associatedContents.results[i].contentId" To iContentId
Get ComStringOf Of hoJResp "associatedContents.results[i].title" To sTitle
Move (i + 1) To i
Loop
End_Procedure
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": ""
}
]
}
