Chilkat Online Tools

C / Atlassian Confluence Cloud / Get inline tasks based on search parameters

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkJsonObject queryParams;
    HCkHttpResponse resp;
    HCkStringBuilder sbResponseBody;
    HCkJsonObject jResp;
    int respStatusCode;
    int globalId;
    int id;
    int contentId;
    const char *status;
    const char *creator;
    int createDate;
    const char *title;
    const char *description;
    const char *body;
    const char *assignee;
    const char *completeUser;
    int dueDate;
    int updateDate;
    int completeDate;
    int start;
    int limit;
    int size;
    int i;
    int count_i;

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

    http = CkHttp_Create();

    queryParams = CkJsonObject_Create();
    CkJsonObject_UpdateInt(queryParams,"start",0);
    CkJsonObject_UpdateInt(queryParams,"limit",20);
    CkJsonObject_UpdateString(queryParams,"spaceKey","");
    CkJsonObject_UpdateString(queryParams,"pageId","");
    CkJsonObject_UpdateString(queryParams,"assignee","");
    CkJsonObject_UpdateString(queryParams,"creator","");
    CkJsonObject_UpdateString(queryParams,"completedUser","");
    CkJsonObject_UpdateString(queryParams,"duedateFrom","");
    CkJsonObject_UpdateString(queryParams,"duedateTo","");
    CkJsonObject_UpdateString(queryParams,"createdateFrom","");
    CkJsonObject_UpdateString(queryParams,"createdateTo","");
    CkJsonObject_UpdateString(queryParams,"completedateFrom","");
    CkJsonObject_UpdateString(queryParams,"completedateTo","");
    CkJsonObject_UpdateString(queryParams,"status","");

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

    resp = CkHttp_QuickRequestParams(http,"GET","https://your-domain.atlassian.net/wiki/rest/api/inlinetasks/search",queryParams);
    if (CkHttp_getLastMethodSuccess(http) == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(queryParams);
        return;
    }

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

    jResp = CkJsonObject_Create();
    CkJsonObject_LoadSb(jResp,sbResponseBody);
    CkJsonObject_putEmitCompact(jResp,FALSE);

    printf("Response Body:\n");
    printf("%s\n",CkJsonObject_emit(jResp));

    respStatusCode = CkHttpResponse_getStatusCode(resp);
    printf("Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        printf("Response Header:\n");
        printf("%s\n",CkHttpResponse_header(resp));
        printf("Failed.\n");
        CkHttpResponse_Dispose(resp);
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(queryParams);
        CkStringBuilder_Dispose(sbResponseBody);
        CkJsonObject_Dispose(jResp);
        return;
    }

    CkHttpResponse_Dispose(resp);

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

    // {
    //   "results": [
    //     {
    //       "globalId": 73402911,
    //       "id": -12315776,
    //       "contentId": -64437499,
    //       "status": "adipisicing reprehenderit",
    //       "creator": "eiusmod adipisicing nostrud elit aliqua",
    //       "createDate": 96545196,
    //       "title": "eiusmod Duis",
    //       "description": "est voluptate consectetur",
    //       "body": "ut dolor laborum amet in",
    //       "assignee": "id qui Excepteur veniam",
    //       "completeUser": "dolor in",
    //       "dueDate": -37801344,
    //       "updateDate": -17760646,
    //       "completeDate": -16013738
    //     },
    //     {
    //       "globalId": 10778681,
    //       "id": 56408304,
    //       "contentId": -21387009,
    //       "status": "ut in nulla",
    //       "creator": "amet laborum tempor dolor culpa",
    //       "createDate": -75309367,
    //       "title": "esse cillum dolor magna",
    //       "description": "fugiat",
    //       "body": "aliqua enim",
    //       "assignee": "exercitation eiusmod dolore et occaecat",
    //       "completeUser": "nisi irure incididunt",
    //       "dueDate": -59867179,
    //       "updateDate": 535300,
    //       "completeDate": -27504056
    //     }
    //   ],
    //   "start": 92594856,
    //   "limit": 14573716,
    //   "size": -75971688
    // }

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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    start = CkJsonObject_IntOf(jResp,"start");
    limit = CkJsonObject_IntOf(jResp,"limit");
    size = CkJsonObject_IntOf(jResp,"size");
    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"results");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        globalId = CkJsonObject_IntOf(jResp,"results[i].globalId");
        id = CkJsonObject_IntOf(jResp,"results[i].id");
        contentId = CkJsonObject_IntOf(jResp,"results[i].contentId");
        status = CkJsonObject_stringOf(jResp,"results[i].status");
        creator = CkJsonObject_stringOf(jResp,"results[i].creator");
        createDate = CkJsonObject_IntOf(jResp,"results[i].createDate");
        title = CkJsonObject_stringOf(jResp,"results[i].title");
        description = CkJsonObject_stringOf(jResp,"results[i].description");
        body = CkJsonObject_stringOf(jResp,"results[i].body");
        assignee = CkJsonObject_stringOf(jResp,"results[i].assignee");
        completeUser = CkJsonObject_stringOf(jResp,"results[i].completeUser");
        dueDate = CkJsonObject_IntOf(jResp,"results[i].dueDate");
        updateDate = CkJsonObject_IntOf(jResp,"results[i].updateDate");
        completeDate = CkJsonObject_IntOf(jResp,"results[i].completeDate");
        i = i + 1;
    }



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

    }

Curl Command

curl -G -d "start=0"
	-d "limit=20"
	-d "spaceKey="
	-d "pageId="
	-d "assignee="
	-d "creator="
	-d "completedUser="
	-d "duedateFrom="
	-d "duedateTo="
	-d "createdateFrom="
	-d "createdateTo="
	-d "completedateFrom="
	-d "completedateTo="
	-d "status="
	-H "Authorization: Bearer <access_token>"
https://your-domain.atlassian.net/wiki/rest/api/inlinetasks/search

Postman Collection Item JSON

{
  "name": "Get inline tasks based on search parameters",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/inlinetasks/search?start=0&limit=20&spaceKey=&pageId=&assignee=&creator=&completedUser=&duedateFrom=&duedateTo=&createdateFrom=&createdateTo=&completedateFrom=&completedateTo=&status=",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "inlinetasks",
        "search"
      ],
      "query": [
        {
          "key": "start",
          "value": "0",
          "description": "The starting offset for the results."
        },
        {
          "key": "limit",
          "value": "20",
          "description": "The number of results to be returned."
        },
        {
          "key": "spaceKey",
          "value": "",
          "description": "The space key of a space. Multiple space keys can be specified."
        },
        {
          "key": "pageId",
          "value": "",
          "description": "The page id of a page. Multiple page ids can be specified."
        },
        {
          "key": "assignee",
          "value": "",
          "description": "Account ID of a user to whom a task is assigned. Multiple users can be specified."
        },
        {
          "key": "creator",
          "value": "",
          "description": "Account ID of a user to who created a task. Multiple users can be specified."
        },
        {
          "key": "completedUser",
          "value": "",
          "description": "Account ID of a user who completed a task. Multiple users can be specified."
        },
        {
          "key": "duedateFrom",
          "value": "",
          "description": "Start of date range based on due dates (inclusive)."
        },
        {
          "key": "duedateTo",
          "value": "",
          "description": "End of date range based on due dates (inclusive)."
        },
        {
          "key": "createdateFrom",
          "value": "",
          "description": "Start of date range based on create dates (inclusive)."
        },
        {
          "key": "createdateTo",
          "value": "",
          "description": "End of date range based on create dates (inclusive)."
        },
        {
          "key": "completedateFrom",
          "value": "",
          "description": "Start of date range based on complete dates (inclusive)."
        },
        {
          "key": "completedateTo",
          "value": "",
          "description": "End of date range based on complete dates (inclusive)."
        },
        {
          "key": "status",
          "value": "",
          "description": "The status of the task. (checked/unchecked)"
        }
      ]
    },
    "description": "Returns inline tasks based on the search query.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission). Only tasks\nin contents that the user has permission to view are returned."
  },
  "response": [
    {
      "name": "Returned if the query fetches zero or more results.",
      "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/inlinetasks/search?start=0&limit=20&spaceKey=&pageId=&assignee=&creator=&completedUser=&duedateFrom=&duedateTo=&createdateFrom=&createdateTo=&completedateFrom=&completedateTo=&status=",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "inlinetasks",
            "search"
          ],
          "query": [
            {
              "key": "start",
              "value": "0"
            },
            {
              "key": "limit",
              "value": "20"
            },
            {
              "key": "spaceKey",
              "value": ""
            },
            {
              "key": "pageId",
              "value": ""
            },
            {
              "key": "assignee",
              "value": ""
            },
            {
              "key": "creator",
              "value": ""
            },
            {
              "key": "completedUser",
              "value": ""
            },
            {
              "key": "duedateFrom",
              "value": ""
            },
            {
              "key": "duedateTo",
              "value": ""
            },
            {
              "key": "createdateFrom",
              "value": ""
            },
            {
              "key": "createdateTo",
              "value": ""
            },
            {
              "key": "completedateFrom",
              "value": ""
            },
            {
              "key": "completedateTo",
              "value": ""
            },
            {
              "key": "status",
              "value": ""
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"results\": [\n  {\n   \"globalId\": 73402911,\n   \"id\": -12315776,\n   \"contentId\": -64437499,\n   \"status\": \"adipisicing reprehenderit\",\n   \"creator\": \"eiusmod adipisicing nostrud elit aliqua\",\n   \"createDate\": 96545196,\n   \"title\": \"eiusmod Duis\",\n   \"description\": \"est voluptate consectetur\",\n   \"body\": \"ut dolor laborum amet in\",\n   \"assignee\": \"id qui Excepteur veniam\",\n   \"completeUser\": \"dolor in\",\n   \"dueDate\": -37801344,\n   \"updateDate\": -17760646,\n   \"completeDate\": -16013738\n  },\n  {\n   \"globalId\": 10778681,\n   \"id\": 56408304,\n   \"contentId\": -21387009,\n   \"status\": \"ut in nulla\",\n   \"creator\": \"amet laborum tempor dolor culpa\",\n   \"createDate\": -75309367,\n   \"title\": \"esse cillum dolor magna\",\n   \"description\": \"fugiat\",\n   \"body\": \"aliqua enim\",\n   \"assignee\": \"exercitation eiusmod dolore et occaecat\",\n   \"completeUser\": \"nisi irure incididunt\",\n   \"dueDate\": -59867179,\n   \"updateDate\": 535300,\n   \"completeDate\": -27504056\n  }\n ],\n \"start\": 92594856,\n \"limit\": 14573716,\n \"size\": -75971688\n}"
    },
    {
      "name": "Returned if the calling user does not have permission to view\nany 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/inlinetasks/search?start=0&limit=20&spaceKey=&pageId=&assignee=&creator=&completedUser=&duedateFrom=&duedateTo=&createdateFrom=&createdateTo=&completedateFrom=&completedateTo=&status=",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "inlinetasks",
            "search"
          ],
          "query": [
            {
              "key": "start",
              "value": "0"
            },
            {
              "key": "limit",
              "value": "20"
            },
            {
              "key": "spaceKey",
              "value": ""
            },
            {
              "key": "pageId",
              "value": ""
            },
            {
              "key": "assignee",
              "value": ""
            },
            {
              "key": "creator",
              "value": ""
            },
            {
              "key": "completedUser",
              "value": ""
            },
            {
              "key": "duedateFrom",
              "value": ""
            },
            {
              "key": "duedateTo",
              "value": ""
            },
            {
              "key": "createdateFrom",
              "value": ""
            },
            {
              "key": "createdateTo",
              "value": ""
            },
            {
              "key": "completedateFrom",
              "value": ""
            },
            {
              "key": "completedateTo",
              "value": ""
            },
            {
              "key": "status",
              "value": ""
            }
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}