Chilkat Online Tools

Xojo / Atlassian Confluence Cloud / Get group

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://your-domain.atlassian.net/wiki/rest/api/group/:groupName",sbResponseBody)
If (success = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = http.LastStatus
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(http.LastHeader)
    System.DebugLog("Failed.")
    Return
End If

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "type": "group",
//   "name": "et exercitation",
//   "id": "ut Duis dolore consectetur",
//   "_links": {}
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

Dim v_type As String
v_type = jResp.StringOf("type")
Dim name As String
name = jResp.StringOf("name")
Dim id As String
id = jResp.StringOf("id")

Curl Command

curl -X GET
https://your-domain.atlassian.net/wiki/rest/api/group/:groupName

Postman Collection Item JSON

{
  "name": "Get group",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/group/:groupName",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "group",
        ":groupName"
      ],
      "variable": [
        {
          "key": "groupName",
          "value": "<string>",
          "type": "string",
          "description": "(Required) The name of the group. This is the same as the group name shown in\nthe Confluence administration console."
        }
      ]
    },
    "description": "Returns a user group for a given group name.\n\nUse updated Get group API\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission)."
  },
  "response": [
    {
      "name": "Returned if the requested group is returned.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/api/group/:groupName",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "group",
            ":groupName"
          ],
          "variable": [
            {
              "key": "groupName"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"type\": \"group\",\n \"name\": \"et exercitation\",\n \"id\": \"ut Duis dolore consectetur\",\n \"_links\": {}\n}"
    },
    {
      "name": "Returned if the calling user does not have permission to view\ngroups.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/api/group/:groupName",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "group",
            ":groupName"
          ],
          "variable": [
            {
              "key": "groupName"
            }
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}