Chilkat Online Tools

delphiDll / Atlassian Confluence Cloud / Convert user identifiers to account IDs in CQL queries

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;

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

http := CkHttp_Create();

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "queryStrings": [
//     "<string>",
//     "<string>"
//   ]
// }

json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'queryStrings[0]','<string>');
CkJsonObject_UpdateString(json,'queryStrings[1]','<string>');

CkHttp_SetRequestHeader(http,'Content-Type','application/json');

resp := CkHttp_PostJson3(http,'https://your-domain.atlassian.net/wiki/rest/experimental/cql/pdcleaner','application/json',json);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttpResponse__header(resp));
    Memo1.Lines.Add('Failed.');
    CkHttpResponse_Dispose(resp);
    Exit;
  end;
CkHttpResponse_Dispose(resp);

CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-d '{
    "queryStrings": [
        "<string>",
        "<string>"
    ]
}'
https://your-domain.atlassian.net/wiki/rest/experimental/cql/pdcleaner

Postman Collection Item JSON

{
  "name": "Convert user identifiers to account IDs in CQL queries",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"queryStrings\": [\n        \"<string>\",\n        \"<string>\"\n    ]\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/experimental/cql/pdcleaner",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "experimental",
        "cql",
        "pdcleaner"
      ]
    },
    "description": "Converts one or more CQL queries with user identifiers (username or user key)\nto equivalent CQL queries with account IDs.\n\nYou may wish to use this operation if your system stores CQL queries and you\nwant to make them GDPR-compliant. For more information about GDPR-related changes,\nsee the [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/).\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None"
  },
  "response": [
    {
      "name": "Returned if the request is successful. The CQL queries are returned\nin the same order that they were passed. Note that if the user in a\nCQL query cannot be found, a `200` code is still returned but the username\nor key is converted to an empty string.",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"queryStrings\": [\n        \"<string>\",\n        \"<string>\"\n    ]\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/experimental/cql/pdcleaner",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "experimental",
            "cql",
            "pdcleaner"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "\"{ \\\"queryStrings\\\": [ \\\"type = page and creator != '847586:5371623a-12b4-1a11-ed01-a53542f02dd1' and space = DEV\\\"] }\""
    },
    {
      "name": "Returned if:\n\n* At least one of the queries cannot be converted. For example, the\nCQL has invalid operators or invalid keywords.\n* More than 100 CQL queries are included in the request.",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"queryStrings\": [\n        \"<string>\",\n        \"<string>\"\n    ]\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/experimental/cql/pdcleaner",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "experimental",
            "cql",
            "pdcleaner"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}