Node.js / Atlassian Confluence Cloud / Get inline tasks based on search parameters
Back to Collection Items
var os = require('os');
if (os.platform() == 'win32') {
if (os.arch() == 'ia32') {
var chilkat = require('@chilkat/ck-node21-win-ia32');
} else {
var chilkat = require('@chilkat/ck-node21-win64');
}
} else if (os.platform() == 'linux') {
if (os.arch() == 'arm') {
var chilkat = require('@chilkat/ck-node21-arm');
} else if (os.arch() == 'x86') {
var chilkat = require('@chilkat/ck-node21-linux32');
} else {
var chilkat = require('@chilkat/ck-node21-linux64');
}
} else if (os.platform() == 'darwin') {
if (os.arch() == 'arm64') {
var chilkat = require('@chilkat/ck-node21-mac-m1');
} else {
var chilkat = require('@chilkat/ck-node21-macosx');
}
}
function chilkatExample() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
var http = new chilkat.Http();
var success;
var queryParams = new chilkat.JsonObject();
queryParams.UpdateInt("start",0);
queryParams.UpdateInt("limit",20);
queryParams.UpdateString("spaceKey","");
queryParams.UpdateString("pageId","");
queryParams.UpdateString("assignee","");
queryParams.UpdateString("creator","");
queryParams.UpdateString("completedUser","");
queryParams.UpdateString("duedateFrom","");
queryParams.UpdateString("duedateTo","");
queryParams.UpdateString("createdateFrom","");
queryParams.UpdateString("createdateTo","");
queryParams.UpdateString("completedateFrom","");
queryParams.UpdateString("completedateTo","");
queryParams.UpdateString("status","");
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>";
// resp: HttpResponse
var resp = http.QuickRequestParams("GET","https://your-domain.atlassian.net/wiki/rest/api/inlinetasks/search",queryParams);
if (http.LastMethodSuccess == false) {
console.log(http.LastErrorText);
return;
}
var sbResponseBody = new chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);
var jResp = new chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;
console.log("Response Body:");
console.log(jResp.Emit());
var respStatusCode = resp.StatusCode;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
console.log("Response Header:");
console.log(resp.Header);
console.log("Failed.");
return;
}
// 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
var globalId;
var id;
var contentId;
var status;
var creator;
var createDate;
var title;
var description;
var body;
var assignee;
var completeUser;
var dueDate;
var updateDate;
var completeDate;
var start = jResp.IntOf("start");
var limit = jResp.IntOf("limit");
var size = jResp.IntOf("size");
var i = 0;
var count_i = jResp.SizeOfArray("results");
while (i < count_i) {
jResp.I = i;
globalId = jResp.IntOf("results[i].globalId");
id = jResp.IntOf("results[i].id");
contentId = jResp.IntOf("results[i].contentId");
status = jResp.StringOf("results[i].status");
creator = jResp.StringOf("results[i].creator");
createDate = jResp.IntOf("results[i].createDate");
title = jResp.StringOf("results[i].title");
description = jResp.StringOf("results[i].description");
body = jResp.StringOf("results[i].body");
assignee = jResp.StringOf("results[i].assignee");
completeUser = jResp.StringOf("results[i].completeUser");
dueDate = jResp.IntOf("results[i].dueDate");
updateDate = jResp.IntOf("results[i].updateDate");
completeDate = jResp.IntOf("results[i].completeDate");
i = i+1;
}
}
chilkatExample();
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": ""
}
]
}
