Chilkat Online Tools

SQL Server / Atlassian Confluence Cloud / Delete restrictions

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    -- Adds the "Authorization: Bearer <access_token>" header.
    EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'QuickRequest', @resp OUT, 'DELETE', 'https://your-domain.atlassian.net/wiki/rest/api/content/:id/restriction?expand=<string>&expand=<string>'
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        RETURN
      END

    DECLARE @sbResponseBody int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT

    EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody

    DECLARE @jResp int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT

    EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
    EXEC sp_OASetProperty @jResp, 'EmitCompact', 0


    PRINT 'Response Body:'
    EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
    PRINT @sTmp0

    DECLARE @respStatusCode int
    EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT

    PRINT 'Response Status Code = ' + @respStatusCode
    IF @respStatusCode >= 400
      BEGIN

        PRINT 'Response Header:'
        EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
        PRINT @sTmp0

        PRINT 'Failed.'
        EXEC @hr = sp_OADestroy @resp

        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @sbResponseBody
        EXEC @hr = sp_OADestroy @jResp
        RETURN
      END
    EXEC @hr = sp_OADestroy @resp

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

    -- {
    --   "results": [
    --     {
    --       "operation": "purge",
    --       "_expandable": {
    --         "restrictions": "Excepteur dolore Ut labore",
    --         "content": "tempor esse officia"
    --       },
    --       "_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": "in in mollit Ut occaecat",
    --           "group": "irure qui consectetur incididunt"
    --         }
    --       },
    --       "content": {
    --         "value": "<Circular reference to #/components/schemas/Content detected>"
    --       }
    --     },
    --     {
    --       "operation": "delete",
    --       "_expandable": {
    --         "restrictions": "nisi id",
    --         "content": "ut in mollit enim"
    --       },
    --       "_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": "est voluptate",
    --           "group": "in"
    --         }
    --       },
    --       "content": {
    --         "value": "<Circular reference to #/components/schemas/Content detected>"
    --       }
    --     }
    --   ],
    --   "start": 17789838,
    --   "limit": 13313455,
    --   "size": -47874490,
    --   "restrictionsHash": "Lorem commodo pariatur Ut eiusmod",
    --   "_links": {}
    -- }

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

    DECLARE @operation nvarchar(4000)

    DECLARE @Restrictions nvarchar(4000)

    DECLARE @Content nvarchar(4000)

    DECLARE @ResultsValue nvarchar(4000)

    DECLARE @StartValue nvarchar(4000)

    DECLARE @LimitValue nvarchar(4000)

    DECLARE @SizeValue nvarchar(4000)

    DECLARE @User nvarchar(4000)

    DECLARE @Group nvarchar(4000)

    DECLARE @contentValue nvarchar(4000)

    DECLARE @start int
    EXEC sp_OAMethod @jResp, 'IntOf', @start OUT, 'start'
    DECLARE @limit int
    EXEC sp_OAMethod @jResp, 'IntOf', @limit OUT, 'limit'
    DECLARE @size int
    EXEC sp_OAMethod @jResp, 'IntOf', @size OUT, 'size'
    DECLARE @restrictionsHash nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @restrictionsHash OUT, 'restrictionsHash'
    DECLARE @i int
    SELECT @i = 0
    DECLARE @count_i int
    EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'results'
    WHILE @i < @count_i
      BEGIN
        EXEC sp_OASetProperty @jResp, 'I', @i
        EXEC sp_OAMethod @jResp, 'StringOf', @operation OUT, 'results[i].operation'
        EXEC sp_OAMethod @jResp, 'StringOf', @Restrictions OUT, 'results[i]._expandable.restrictions'
        EXEC sp_OAMethod @jResp, 'StringOf', @Content OUT, 'results[i]._expandable.content'
        EXEC sp_OAMethod @jResp, 'StringOf', @ResultsValue OUT, 'results[i].restrictions.user.results.value'
        EXEC sp_OAMethod @jResp, 'StringOf', @StartValue OUT, 'results[i].restrictions.user.start.value'
        EXEC sp_OAMethod @jResp, 'StringOf', @LimitValue OUT, 'results[i].restrictions.user.limit.value'
        EXEC sp_OAMethod @jResp, 'StringOf', @SizeValue OUT, 'results[i].restrictions.user.size.value'
        EXEC sp_OAMethod @jResp, 'StringOf', @ResultsValue OUT, 'results[i].restrictions.group.results.value'
        EXEC sp_OAMethod @jResp, 'StringOf', @StartValue OUT, 'results[i].restrictions.group.start.value'
        EXEC sp_OAMethod @jResp, 'StringOf', @LimitValue OUT, 'results[i].restrictions.group.limit.value'
        EXEC sp_OAMethod @jResp, 'StringOf', @SizeValue OUT, 'results[i].restrictions.group.size.value'
        EXEC sp_OAMethod @jResp, 'StringOf', @User OUT, 'results[i].restrictions._expandable.user'
        EXEC sp_OAMethod @jResp, 'StringOf', @Group OUT, 'results[i].restrictions._expandable.group'
        EXEC sp_OAMethod @jResp, 'StringOf', @contentValue OUT, 'results[i].content.value'
        SELECT @i = @i + 1
      END

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @sbResponseBody
    EXEC @hr = sp_OADestroy @jResp


END
GO

Curl Command

curl -X DELETE
	-H "Authorization: Bearer <access_token>"
https://your-domain.atlassian.net/wiki/rest/api/content/:id/restriction?expand=<string>&expand=<string>

Postman Collection Item JSON

{
  "name": "Delete restrictions",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "DELETE",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/content/:id/restriction?expand=<string>&expand=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "content",
        ":id",
        "restriction"
      ],
      "query": [
        {
          "key": "expand",
          "value": "<string>",
          "description": "A multi-value parameter indicating which properties of the content\nrestrictions (returned in response) to expand.\n\n- `restrictions.user` returns the piece of content that the restrictions are\napplied to. Expanded by default.\n- `restrictions.group` returns the piece of content that the restrictions are\napplied to. Expanded by default.\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 (returned in response) to expand.\n\n- `restrictions.user` returns the piece of content that the restrictions are\napplied to. Expanded by default.\n- `restrictions.group` returns the piece of content that the restrictions are\napplied to. Expanded by default.\n- `content` returns the piece of content that the restrictions are\napplied to."
        }
      ],
      "variable": [
        {
          "key": "id",
          "value": "<string>",
          "type": "string",
          "description": "(Required) The ID of the content to remove restrictions from."
        }
      ]
    },
    "description": "Removes all restrictions (read and update) on a piece of content.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to edit the content."
  },
  "response": [
    {
      "name": "Returned if the restrictions are removed.",
      "originalRequest": {
        "method": "DELETE",
        "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>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "content",
            ":id",
            "restriction"
          ],
          "query": [
            {
              "key": "expand",
              "value": "<string>"
            },
            {
              "key": "expand",
              "value": "<string>"
            }
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"results\": [\n  {\n   \"operation\": \"purge\",\n   \"_expandable\": {\n    \"restrictions\": \"Excepteur dolore Ut labore\",\n    \"content\": \"tempor esse officia\"\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\": \"in in mollit Ut occaecat\",\n     \"group\": \"irure qui consectetur incididunt\"\n    }\n   },\n   \"content\": {\n    \"value\": \"<Circular reference to #/components/schemas/Content detected>\"\n   }\n  },\n  {\n   \"operation\": \"delete\",\n   \"_expandable\": {\n    \"restrictions\": \"nisi id\",\n    \"content\": \"ut in mollit enim\"\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\": \"est voluptate\",\n     \"group\": \"in\"\n    }\n   },\n   \"content\": {\n    \"value\": \"<Circular reference to #/components/schemas/Content detected>\"\n   }\n  }\n ],\n \"start\": 17789838,\n \"limit\": 13313455,\n \"size\": -47874490,\n \"restrictionsHash\": \"Lorem commodo pariatur Ut eiusmod\",\n \"_links\": {}\n}"
    },
    {
      "name": "Returned if any of the above validation rules are violated",
      "originalRequest": {
        "method": "DELETE",
        "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>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "content",
            ":id",
            "restriction"
          ],
          "query": [
            {
              "key": "expand",
              "value": "<string>"
            },
            {
              "key": "expand",
              "value": "<string>"
            }
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "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 alter the\nrestrictions on the content.",
      "originalRequest": {
        "method": "DELETE",
        "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>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "content",
            ":id",
            "restriction"
          ],
          "query": [
            {
              "key": "expand",
              "value": "<string>"
            },
            {
              "key": "expand",
              "value": "<string>"
            }
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "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": "DELETE",
        "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>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "content",
            ":id",
            "restriction"
          ],
          "query": [
            {
              "key": "expand",
              "value": "<string>"
            },
            {
              "key": "expand",
              "value": "<string>"
            }
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}