Executes a filter query against items and returns paginated results.
curl --request POST \
--url https://{install}/api/item/filter \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"criteria": {
"container": [
"<string>"
],
"conditionGroup": [
{
"condition": [
{
"id": "<string>",
"leftSide": "<string>",
"rightSide": "<string>",
"operator": 123
}
]
}
],
"includeClosed": true,
"sortField": "<string>",
"sortDescending": true
},
"page": 123,
"internalStatusClosed": [
"<string>"
],
"internalStatusFieldId": "<string>"
}
'import requests
url = "https://{install}/api/item/filter"
payload = {
"criteria": {
"container": ["<string>"],
"conditionGroup": [{ "condition": [
{
"id": "<string>",
"leftSide": "<string>",
"rightSide": "<string>",
"operator": 123
}
] }],
"includeClosed": True,
"sortField": "<string>",
"sortDescending": True
},
"page": 123,
"internalStatusClosed": ["<string>"],
"internalStatusFieldId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
criteria: {
container: ['<string>'],
conditionGroup: [
{
condition: [{id: '<string>', leftSide: '<string>', rightSide: '<string>', operator: 123}]
}
],
includeClosed: true,
sortField: '<string>',
sortDescending: true
},
page: 123,
internalStatusClosed: ['<string>'],
internalStatusFieldId: '<string>'
})
};
fetch('https://{install}/api/item/filter', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));using RestSharp;
var options = new RestClientOptions("https://{install}/api/item/filter");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"criteria\": {\n \"container\": [\n \"<string>\"\n ],\n \"conditionGroup\": [\n {\n \"condition\": [\n {\n \"id\": \"<string>\",\n \"leftSide\": \"<string>\",\n \"rightSide\": \"<string>\",\n \"operator\": 123\n }\n ]\n }\n ],\n \"includeClosed\": true,\n \"sortField\": \"<string>\",\n \"sortDescending\": true\n },\n \"page\": 123,\n \"internalStatusClosed\": [\n \"<string>\"\n ],\n \"internalStatusFieldId\": \"<string>\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{install}/api/item/filter",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'criteria' => [
'container' => [
'<string>'
],
'conditionGroup' => [
[
'condition' => [
[
'id' => '<string>',
'leftSide' => '<string>',
'rightSide' => '<string>',
'operator' => 123
]
]
]
],
'includeClosed' => true,
'sortField' => '<string>',
'sortDescending' => true
],
'page' => 123,
'internalStatusClosed' => [
'<string>'
],
'internalStatusFieldId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{install}/api/item/filter"
payload := strings.NewReader("{\n \"criteria\": {\n \"container\": [\n \"<string>\"\n ],\n \"conditionGroup\": [\n {\n \"condition\": [\n {\n \"id\": \"<string>\",\n \"leftSide\": \"<string>\",\n \"rightSide\": \"<string>\",\n \"operator\": 123\n }\n ]\n }\n ],\n \"includeClosed\": true,\n \"sortField\": \"<string>\",\n \"sortDescending\": true\n },\n \"page\": 123,\n \"internalStatusClosed\": [\n \"<string>\"\n ],\n \"internalStatusFieldId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{install}/api/item/filter")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"criteria\": {\n \"container\": [\n \"<string>\"\n ],\n \"conditionGroup\": [\n {\n \"condition\": [\n {\n \"id\": \"<string>\",\n \"leftSide\": \"<string>\",\n \"rightSide\": \"<string>\",\n \"operator\": 123\n }\n ]\n }\n ],\n \"includeClosed\": true,\n \"sortField\": \"<string>\",\n \"sortDescending\": true\n },\n \"page\": 123,\n \"internalStatusClosed\": [\n \"<string>\"\n ],\n \"internalStatusFieldId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{install}/api/item/filter")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"criteria\": {\n \"container\": [\n \"<string>\"\n ],\n \"conditionGroup\": [\n {\n \"condition\": [\n {\n \"id\": \"<string>\",\n \"leftSide\": \"<string>\",\n \"rightSide\": \"<string>\",\n \"operator\": 123\n }\n ]\n }\n ],\n \"includeClosed\": true,\n \"sortField\": \"<string>\",\n \"sortDescending\": true\n },\n \"page\": 123,\n \"internalStatusClosed\": [\n \"<string>\"\n ],\n \"internalStatusFieldId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"entity": "<string>",
"containerId": "<string>",
"processId": "<string>",
"sequence": 123,
"boardId": "<string>",
"cycleId": "<string>",
"resourceType": 123,
"resourceId": "<string>",
"dateOpened": "2023-11-07T05:31:56Z",
"dateWorking": "2023-11-07T05:31:56Z",
"dateClosed": "2023-11-07T05:31:56Z",
"time": [
{
"id": "<string>",
"dated": "2023-11-07T05:31:56Z",
"userId": "<string>",
"timeTypeId": "<string>",
"timeLogged": "<string>",
"comment": "<string>",
"status": 123
}
],
"field": [
{
"fieldId": "<string>",
"data": "<string>"
}
],
"meta": [
{
"key": "<string>",
"value": "<string>"
}
],
"clockStart": "2023-11-07T05:31:56Z",
"clockFinish": "2023-11-07T05:31:56Z",
"clockDelta": 123,
"clockHours": 123,
"clockStatus": 123,
"dependencyKey": "<string>",
"dependencyIndent": 123,
"dependencyChild": 123,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"total": 123,
"pageSize": 123,
"pages": 123,
"page": 123
}Items
Executes a filter query against items and returns paginated results.
POST
/
api
/
item
/
filter
Executes a filter query against items and returns paginated results.
curl --request POST \
--url https://{install}/api/item/filter \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"criteria": {
"container": [
"<string>"
],
"conditionGroup": [
{
"condition": [
{
"id": "<string>",
"leftSide": "<string>",
"rightSide": "<string>",
"operator": 123
}
]
}
],
"includeClosed": true,
"sortField": "<string>",
"sortDescending": true
},
"page": 123,
"internalStatusClosed": [
"<string>"
],
"internalStatusFieldId": "<string>"
}
'import requests
url = "https://{install}/api/item/filter"
payload = {
"criteria": {
"container": ["<string>"],
"conditionGroup": [{ "condition": [
{
"id": "<string>",
"leftSide": "<string>",
"rightSide": "<string>",
"operator": 123
}
] }],
"includeClosed": True,
"sortField": "<string>",
"sortDescending": True
},
"page": 123,
"internalStatusClosed": ["<string>"],
"internalStatusFieldId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
criteria: {
container: ['<string>'],
conditionGroup: [
{
condition: [{id: '<string>', leftSide: '<string>', rightSide: '<string>', operator: 123}]
}
],
includeClosed: true,
sortField: '<string>',
sortDescending: true
},
page: 123,
internalStatusClosed: ['<string>'],
internalStatusFieldId: '<string>'
})
};
fetch('https://{install}/api/item/filter', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));using RestSharp;
var options = new RestClientOptions("https://{install}/api/item/filter");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"criteria\": {\n \"container\": [\n \"<string>\"\n ],\n \"conditionGroup\": [\n {\n \"condition\": [\n {\n \"id\": \"<string>\",\n \"leftSide\": \"<string>\",\n \"rightSide\": \"<string>\",\n \"operator\": 123\n }\n ]\n }\n ],\n \"includeClosed\": true,\n \"sortField\": \"<string>\",\n \"sortDescending\": true\n },\n \"page\": 123,\n \"internalStatusClosed\": [\n \"<string>\"\n ],\n \"internalStatusFieldId\": \"<string>\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{install}/api/item/filter",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'criteria' => [
'container' => [
'<string>'
],
'conditionGroup' => [
[
'condition' => [
[
'id' => '<string>',
'leftSide' => '<string>',
'rightSide' => '<string>',
'operator' => 123
]
]
]
],
'includeClosed' => true,
'sortField' => '<string>',
'sortDescending' => true
],
'page' => 123,
'internalStatusClosed' => [
'<string>'
],
'internalStatusFieldId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{install}/api/item/filter"
payload := strings.NewReader("{\n \"criteria\": {\n \"container\": [\n \"<string>\"\n ],\n \"conditionGroup\": [\n {\n \"condition\": [\n {\n \"id\": \"<string>\",\n \"leftSide\": \"<string>\",\n \"rightSide\": \"<string>\",\n \"operator\": 123\n }\n ]\n }\n ],\n \"includeClosed\": true,\n \"sortField\": \"<string>\",\n \"sortDescending\": true\n },\n \"page\": 123,\n \"internalStatusClosed\": [\n \"<string>\"\n ],\n \"internalStatusFieldId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{install}/api/item/filter")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"criteria\": {\n \"container\": [\n \"<string>\"\n ],\n \"conditionGroup\": [\n {\n \"condition\": [\n {\n \"id\": \"<string>\",\n \"leftSide\": \"<string>\",\n \"rightSide\": \"<string>\",\n \"operator\": 123\n }\n ]\n }\n ],\n \"includeClosed\": true,\n \"sortField\": \"<string>\",\n \"sortDescending\": true\n },\n \"page\": 123,\n \"internalStatusClosed\": [\n \"<string>\"\n ],\n \"internalStatusFieldId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{install}/api/item/filter")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"criteria\": {\n \"container\": [\n \"<string>\"\n ],\n \"conditionGroup\": [\n {\n \"condition\": [\n {\n \"id\": \"<string>\",\n \"leftSide\": \"<string>\",\n \"rightSide\": \"<string>\",\n \"operator\": 123\n }\n ]\n }\n ],\n \"includeClosed\": true,\n \"sortField\": \"<string>\",\n \"sortDescending\": true\n },\n \"page\": 123,\n \"internalStatusClosed\": [\n \"<string>\"\n ],\n \"internalStatusFieldId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"entity": "<string>",
"containerId": "<string>",
"processId": "<string>",
"sequence": 123,
"boardId": "<string>",
"cycleId": "<string>",
"resourceType": 123,
"resourceId": "<string>",
"dateOpened": "2023-11-07T05:31:56Z",
"dateWorking": "2023-11-07T05:31:56Z",
"dateClosed": "2023-11-07T05:31:56Z",
"time": [
{
"id": "<string>",
"dated": "2023-11-07T05:31:56Z",
"userId": "<string>",
"timeTypeId": "<string>",
"timeLogged": "<string>",
"comment": "<string>",
"status": 123
}
],
"field": [
{
"fieldId": "<string>",
"data": "<string>"
}
],
"meta": [
{
"key": "<string>",
"value": "<string>"
}
],
"clockStart": "2023-11-07T05:31:56Z",
"clockFinish": "2023-11-07T05:31:56Z",
"clockDelta": 123,
"clockHours": 123,
"clockStatus": 123,
"dependencyKey": "<string>",
"dependencyIndent": 123,
"dependencyChild": 123,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"total": 123,
"pageSize": 123,
"pages": 123,
"page": 123
}Authorizations
JWT Bearer token. Obtain via the OAuth 2.0 token endpoint.
Body
application/jsonapplication/*+json
The filter criteria and page number.
Removes an item from its dependency tree, making it a standalone item that retains its children.
Previous
Finds items by container ID and/or sequence number.
Next
⌘I