Chilkat Online Tools

Java / Atlassian Confluence Cloud / Get group

Back to Collection Items

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp http = new CkHttp();
    boolean success;

    CkStringBuilder sbResponseBody = new CkStringBuilder();
    success = http.QuickGetSb("https://your-domain.atlassian.net/wiki/rest/api/group/:groupName",sbResponseBody);
    if (success == false) {
        System.out.println(http.lastErrorText());
        return;
        }

    CkJsonObject jResp = new CkJsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    System.out.println("Response Body:");
    System.out.println(jResp.emit());

    int respStatusCode = http.get_LastStatus();
    System.out.println("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        System.out.println("Response Header:");
        System.out.println(http.lastHeader());
        System.out.println("Failed.");
        return;
        }

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

    String v_type = jResp.stringOf("type");
    String name = jResp.stringOf("name");
    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": ""
    }
  ]
}