Chilkat Online Tools

Java / Atlassian Confluence Cloud / Get restrictions

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;

    CkJsonObject queryParams = new CkJsonObject();
    queryParams.UpdateString("expand","<string>");
    queryParams.UpdateString("expand","<string>");
    queryParams.UpdateInt("start",0);
    queryParams.UpdateInt("limit",100);

    // Adds the "Authorization: Bearer <access_token>" header.
    http.put_AuthToken("<access_token>");

    CkHttpResponse resp = http.QuickRequestParams("GET","https://your-domain.atlassian.net/wiki/rest/api/content/:id/restriction",queryParams);
    if (http.get_LastMethodSuccess() == false) {
        System.out.println(http.lastErrorText());
        return;
        }

    CkStringBuilder sbResponseBody = new CkStringBuilder();
    resp.GetBodySb(sbResponseBody);

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

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

    int respStatusCode = resp.get_StatusCode();
    System.out.println("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        System.out.println("Response Header:");
        System.out.println(resp.header());
        System.out.println("Failed.");

        return;
        }

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

    // {
    //   "results": [
    //     {
    //       "operation": "copy",
    //       "_expandable": {
    //         "restrictions": "incididunt anim ut id nulla",
    //         "content": "cupidatat"
    //       },
    //       "_links": {},
    //       "restrictions": {
    //         "user": {
    //           "results": {
    //             "value": "<Error: Too many levels of nesting to fake this schema>"
    //           },
    //           "start": {
    //             "value": "<Error: Too many levels of nesting to fake this schema>"
    //           },
    //           "limit": {
    //             "value": "<Error: Too many levels of nesting to fake this schema>"
    //           },
    //           "size": {
    //             "value": "<Error: Too many levels of nesting to fake this schema>"
    //           }
    //         },
    //         "group": {
    //           "results": {
    //             "value": "<Error: Too many levels of nesting to fake this schema>"
    //           },
    //           "start": {
    //             "value": "<Error: Too many levels of nesting to fake this schema>"
    //           },
    //           "limit": {
    //             "value": "<Error: Too many levels of nesting to fake this schema>"
    //           },
    //           "size": {
    //             "value": "<Error: Too many levels of nesting to fake this schema>"
    //           }
    //         },
    //         "_expandable": {
    //           "user": "et laborum",
    //           "group": "qui consequat"
    //         }
    //       },
    //       "content": {
    //         "value": "<Circular reference to #/components/schemas/Content detected>"
    //       }
    //     },
    //     {
    //       "operation": "copy",
    //       "_expandable": {
    //         "restrictions": "ullamco velit Lorem",
    //         "content": "culpa esse sit anim aliqua"
    //       },
    //       "_links": {},
    //       "restrictions": {
    //         "user": {
    //           "results": {
    //             "value": "<Error: Too many levels of nesting to fake this schema>"
    //           },
    //           "start": {
    //             "value": "<Error: Too many levels of nesting to fake this schema>"
    //           },
    //           "limit": {
    //             "value": "<Error: Too many levels of nesting to fake this schema>"
    //           },
    //           "size": {
    //             "value": "<Error: Too many levels of nesting to fake this schema>"
    //           }
    //         },
    //         "group": {
    //           "results": {
    //             "value": "<Error: Too many levels of nesting to fake this schema>"
    //           },
    //           "start": {
    //             "value": "<Error: Too many levels of nesting to fake this schema>"
    //           },
    //           "limit": {
    //             "value": "<Error: Too many levels of nesting to fake this schema>"
    //           },
    //           "size": {
    //             "value": "<Error: Too many levels of nesting to fake this schema>"
    //           }
    //         },
    //         "_expandable": {
    //           "user": "ut",
    //           "group": "ad Ut"
    //         }
    //       },
    //       "content": {
    //         "value": "<Circular reference to #/components/schemas/Content detected>"
    //       }
    //     }
    //   ],
    //   "start": 8238998,
    //   "limit": -43753388,
    //   "size": -64805454,
    //   "restrictionsHash": "ut commodo",
    //   "_links": {}
    // }

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

    String operation;
    String Restrictions;
    String Content;
    String Value;
    String StartValue;
    String LimitValue;
    String SizeValue;
    String ResultsValue;
    String User;
    String Group;
    String contentValue;

    int start = jResp.IntOf("start");
    int limit = jResp.IntOf("limit");
    int size = jResp.IntOf("size");
    String restrictionsHash = jResp.stringOf("restrictionsHash");
    int i = 0;
    int count_i = jResp.SizeOfArray("results");
    while (i < count_i) {
        jResp.put_I(i);
        operation = jResp.stringOf("results[i].operation");
        Restrictions = jResp.stringOf("results[i]._expandable.restrictions");
        Content = jResp.stringOf("results[i]._expandable.content");
        Value = jResp.stringOf("results[i].restrictions.user.results.value");
        StartValue = jResp.stringOf("results[i].restrictions.user.start.value");
        LimitValue = jResp.stringOf("results[i].restrictions.user.limit.value");
        SizeValue = jResp.stringOf("results[i].restrictions.user.size.value");
        ResultsValue = jResp.stringOf("results[i].restrictions.group.results.value");
        StartValue = jResp.stringOf("results[i].restrictions.group.start.value");
        LimitValue = jResp.stringOf("results[i].restrictions.group.limit.value");
        SizeValue = jResp.stringOf("results[i].restrictions.group.size.value");
        User = jResp.stringOf("results[i].restrictions._expandable.user");
        Group = jResp.stringOf("results[i].restrictions._expandable.group");
        contentValue = jResp.stringOf("results[i].content.value");
        i = i+1;
        }
  }
}

Curl Command

curl -G -d "expand=%3Cstring%3E"
	-d "expand=%3Cstring%3E"
	-d "start=0"
	-d "limit=100"
	-H "Authorization: Bearer <access_token>"
https://your-domain.atlassian.net/wiki/rest/api/content/:id/restriction

Postman Collection Item JSON

{
  "name": "Get restrictions",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/content/:id/restriction?expand=<string>&expand=<string>&start=0&limit=100",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "content",
        ":id",
        "restriction"
      ],
      "query": [
        {
          "key": "expand",
          "value": "<string>",
          "description": "A multi-value parameter indicating which properties of the content\nrestrictions to expand. By default, the following objects are expanded:\n`restrictions.user`, `restrictions.group`.\n\n- `restrictions.user` returns the piece of content that the restrictions are\napplied to.\n- `restrictions.group` returns the piece of content that the restrictions are\napplied to.\n- `content` returns the piece of content that the restrictions are\napplied to."
        },
        {
          "key": "expand",
          "value": "<string>",
          "description": "A multi-value parameter indicating which properties of the content\nrestrictions to expand. By default, the following objects are expanded:\n`restrictions.user`, `restrictions.group`.\n\n- `restrictions.user` returns the piece of content that the restrictions are\napplied to.\n- `restrictions.group` returns the piece of content that the restrictions are\napplied to.\n- `content` returns the piece of content that the restrictions are\napplied to."
        },
        {
          "key": "start",
          "value": "0",
          "description": "The starting index of the users and groups in the returned restrictions."
        },
        {
          "key": "limit",
          "value": "100",
          "description": "The maximum number of users and the maximum number of groups, in the\nreturned restrictions, to return per page. Note, this may be restricted\nby fixed system limits."
        }
      ],
      "variable": [
        {
          "key": "id",
          "value": "<string>",
          "type": "string",
          "description": "(Required) The ID of the content to be queried for its restrictions."
        }
      ]
    },
    "description": "Returns the restrictions on a piece of content.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view the content."
  },
  "response": [
    {
      "name": "Returned if the requested restrictions are returned.",
      "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/content/:id/restriction?expand=<string>&expand=<string>&start=0&limit=100",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "content",
            ":id",
            "restriction"
          ],
          "query": [
            {
              "key": "expand",
              "value": "<string>"
            },
            {
              "key": "expand",
              "value": "<string>"
            },
            {
              "key": "start",
              "value": "0"
            },
            {
              "key": "limit",
              "value": "100"
            }
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"results\": [\n  {\n   \"operation\": \"copy\",\n   \"_expandable\": {\n    \"restrictions\": \"incididunt anim ut id nulla\",\n    \"content\": \"cupidatat\"\n   },\n   \"_links\": {},\n   \"restrictions\": {\n    \"user\": {\n     \"results\": {\n      \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n     },\n     \"start\": {\n      \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n     },\n     \"limit\": {\n      \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n     },\n     \"size\": {\n      \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n     }\n    },\n    \"group\": {\n     \"results\": {\n      \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n     },\n     \"start\": {\n      \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n     },\n     \"limit\": {\n      \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n     },\n     \"size\": {\n      \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n     }\n    },\n    \"_expandable\": {\n     \"user\": \"et laborum\",\n     \"group\": \"qui consequat\"\n    }\n   },\n   \"content\": {\n    \"value\": \"<Circular reference to #/components/schemas/Content detected>\"\n   }\n  },\n  {\n   \"operation\": \"copy\",\n   \"_expandable\": {\n    \"restrictions\": \"ullamco velit Lorem\",\n    \"content\": \"culpa esse sit anim aliqua\"\n   },\n   \"_links\": {},\n   \"restrictions\": {\n    \"user\": {\n     \"results\": {\n      \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n     },\n     \"start\": {\n      \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n     },\n     \"limit\": {\n      \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n     },\n     \"size\": {\n      \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n     }\n    },\n    \"group\": {\n     \"results\": {\n      \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n     },\n     \"start\": {\n      \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n     },\n     \"limit\": {\n      \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n     },\n     \"size\": {\n      \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n     }\n    },\n    \"_expandable\": {\n     \"user\": \"ut\",\n     \"group\": \"ad Ut\"\n    }\n   },\n   \"content\": {\n    \"value\": \"<Circular reference to #/components/schemas/Content detected>\"\n   }\n  }\n ],\n \"start\": 8238998,\n \"limit\": -43753388,\n \"size\": -64805454,\n \"restrictionsHash\": \"ut commodo\",\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": "GET",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: oauth2",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/content/:id/restriction?expand=<string>&expand=<string>&start=0&limit=100",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "content",
            ":id",
            "restriction"
          ],
          "query": [
            {
              "key": "expand",
              "value": "<string>"
            },
            {
              "key": "expand",
              "value": "<string>"
            },
            {
              "key": "start",
              "value": "0"
            },
            {
              "key": "limit",
              "value": "100"
            }
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}