Query

POST

api

tasks

query

curl --request POST \
  --url https://api.onfragment.com/api/v1/tasks/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "selects": [
    "<string>"
  ],
  "metrics": {},
  "condition": {
    "combinator": "and",
    "conditions": [
      {}
    ],
    "field": "<string>",
    "operator": "==",
    "negated": false,
    "value": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "target": "<string>"
  },
  "groups": [
    "<string>"
  ],
  "sorts": [
    {
      "field": "<string>",
      "condition": {
        "combinator": "and",
        "conditions": [
          {}
        ],
        "field": "<string>",
        "operator": "==",
        "negated": true,
        "value": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "target": "<string>"
      },
      "direction": "ascending"
    }
  ],
  "limit": 123,
  "variables": [
    {
      "field": "<string>",
      "value": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "functions": [
    {
      "field": "<string>",
      "function": "<string>",
      "params": {}
    }
  ],
  "queries": [
    {}
  ],
  "aliases": {},
  "engine": "orm"
}'

{
  "items": [
    {
      "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "archived": true,
      "status": "TODO",
      "legacy_data": {},
      "skills": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "queue_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "queue_uid_expression": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "queue_uid_column": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "assignee_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "participants": {},
      "case_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "parent_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "due_at": "2023-11-07T05:31:56Z",
      "fields": {},
      "form_data": {},
      "form_type": "<string>",
      "assigned_at": "2023-11-07T05:31:56Z",
      "started_at": "2023-11-07T05:31:56Z",
      "done_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "assignee_updated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "queue_updated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_assigned_player": true,
      "internal_created_at": "2023-11-07T05:31:56Z",
      "internal_updated_at": "2023-11-07T05:31:56Z",
      "external_created_at": "2023-11-07T05:31:56Z",
      "external_updated_at": "2023-11-07T05:31:56Z",
      "external_status": "TODO",
      "external_status_updated_at": "2023-11-07T05:31:56Z",
      "external_assignee_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "queue_time": 123,
      "queue_time_business": 123,
      "work_time": 123,
      "work_time_business": 123,
      "incremental_work_time": 123,
      "incremental_work_time_business": 123,
      "resolution_time": 123,
      "resolution_time_business": 123,
      "num_children": 123,
      "num_children_done": 123,
      "sla_breach_at": "2023-11-07T05:31:56Z",
      "sla_breach_business_at": "2023-11-07T05:31:56Z",
      "wait_time": 123,
      "wait_time_business": 123,
      "played_at": "2023-11-07T05:31:56Z",
      "reviewer_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "review_form_data": {},
      "reviewed_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "before_cursor": "<string>",
    "after_cursor": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

fragment-user-agent

string | null

fragment-account

string | null

fragment-versioning

string | null

fragment-user

string | null

Query Parameters

archived

default:false

Body

application/json

Query schema.

selects

string[] | null

metrics

object | null

condition

object | null

Tree-like condition schema

condition.combinator

enum<string>

Combinators.

Available options:

and,

or

condition.conditions

object[]

Tree-like condition schema

condition.conditions.combinator

enum<string>

Combinators.

Available options:

and,

or

condition.conditions.conditions

object[]

Tree-like condition schema

condition.conditions.field

string | null

condition.conditions.operator

enum<string> | null

Filter operators.

Available options:

==,

!=,

>,

<,

>=,

<=,

in,

not_in,

includes,

not_includes,

contained_by,

contains,

overlaps,

null,

not_null

condition.conditions.negated

boolean

default:false

condition.conditions.value

condition.conditions.target

string | null

condition.field

string | null

condition.operator

enum<string> | null

Filter operators.

Available options:

==,

!=,

>,

<,

>=,

<=,

in,

not_in,

includes,

not_includes,

contained_by,

contains,

overlaps,

null,

not_null

condition.negated

boolean

default:false

condition.value

condition.target

string | null

groups

string[] | null

sorts

object[] | null

Sort schema.

sorts.direction

enum<string>

required

Direction.

Available options:

ascending,

descending

sorts.field

string | null

sorts.condition

object | null

Tree-like condition schema

sorts.condition.combinator

enum<string>

Combinators.

Available options:

and,

or

sorts.condition.conditions

object[]

Tree-like condition schema

sorts.condition.field

string | null

sorts.condition.operator

enum<string> | null

Filter operators.

Available options:

==,

!=,

>,

<,

>=,

<=,

in,

not_in,

includes,

not_includes,

contained_by,

contains,

overlaps,

null,

not_null

sorts.condition.negated

boolean

default:false

sorts.condition.value

sorts.condition.target

string | null

limit

integer | null

variables

object[] | null

Variable class.

functions

object[] | null

Extra fields based on functions.

queries

object[] | null

Query schema.

queries.selects

string[] | null

queries.metrics

object | null

queries.condition

object | null

Tree-like condition schema

queries.condition.combinator

enum<string>

Combinators.

Available options:

and,

or

queries.condition.conditions

object[]

Tree-like condition schema

queries.condition.field

string | null

queries.condition.operator

enum<string> | null

Filter operators.

Available options:

==,

!=,

>,

<,

>=,

<=,

in,

not_in,

includes,

not_includes,

contained_by,

contains,

overlaps,

null,

not_null

queries.condition.negated

boolean

default:false

queries.condition.value

queries.condition.target

string | null

queries.groups

string[] | null

queries.sorts

object[] | null

Sort schema.

queries.limit

integer | null

queries.variables

object[] | null

Variable class.

queries.functions

object[] | null

Extra fields based on functions.

queries.queries

object[] | null

Query schema.

queries.queries.selects

string[] | null

queries.queries.metrics

object | null

queries.queries.condition

object | null

Tree-like condition schema

queries.queries.groups

string[] | null

queries.queries.sorts

object[] | null

Sort schema.

queries.queries.limit

integer | null

queries.queries.variables

object[] | null

Variable class.

queries.queries.functions

object[] | null

Extra fields based on functions.

queries.queries.queries

object[] | null

Query schema.

queries.queries.queries.selects

string[] | null

queries.queries.queries.metrics

object | null

queries.queries.queries.condition

object | null

Tree-like condition schema

queries.queries.queries.groups

string[] | null

queries.queries.queries.sorts

object[] | null

Sort schema.

queries.queries.queries.limit

integer | null

queries.queries.queries.variables

object[] | null

Variable class.

queries.queries.queries.functions

object[] | null

Extra fields based on functions.

queries.queries.queries.queries

object[] | null

Query schema.

queries.queries.queries.aliases

object | null

queries.queries.queries.engine

string

default:orm

queries.queries.aliases

object | null

queries.queries.engine

string

default:orm

queries.aliases

object | null

queries.engine

string

default:orm

aliases

object | null

engine

string

default:orm

Response

200

application/json

Successful Response

items

object[]

required

Task schema, same as Task Model.

items.uid

string

required

items.archived

boolean

required

items.status

enum<string>

required

Task Status Enum.

Available options:

TODO,

STARTED,

DONE

items.legacy_data

object

required

items.skills

string[]

required

items.assignee_uid

string | null

required

items.participants

object

required

items.case_uid

string | null

required

items.parent_uid

string | null

required

items.due_at

string

required

items.fields

object

required

items.form_data

object

required

items.form_type

string | null

required

items.assigned_at

string | null

required

items.started_at

string | null

required

items.done_at

string | null

required

items.created_at

string

required

items.updated_at

string

required

items.assignee_updated_by

string | null

required

items.queue_updated_by

string | null

required

items.is_assigned_player

boolean | null

required

items.internal_created_at

string | null

required

items.internal_updated_at

string | null

required

items.external_created_at

string | null

required

items.external_updated_at

string | null

required

items.external_status

enum<string> | null

required

Task Status Enum.

Available options:

TODO,

STARTED,

DONE

items.external_status_updated_at

string | null

required

items.external_assignee_uid

string | null

required

items.queue_time

integer | null

required

items.queue_time_business

integer | null

required

items.work_time

integer | null

required

items.work_time_business

integer | null

required

items.incremental_work_time

integer | null

required

items.incremental_work_time_business

integer | null

required

items.resolution_time

integer | null

required

items.resolution_time_business

integer | null

required

items.num_children

integer

required

items.num_children_done

integer

required

items.queue_uid

string | null

items.queue_uid_expression

string | null

items.queue_uid_column

string | null

items.sla_breach_at

string | null

items.sla_breach_business_at

string | null

items.wait_time

integer | null

items.wait_time_business

integer | null

items.played_at

string | null

items.reviewer_uid

string | null

items.review_form_data

object | null

items.reviewed_at

string | null

meta

object

Page metadata.

Get Many Create One

curl --request POST \
  --url https://api.onfragment.com/api/v1/tasks/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "selects": [
    "<string>"
  ],
  "metrics": {},
  "condition": {
    "combinator": "and",
    "conditions": [
      {}
    ],
    "field": "<string>",
    "operator": "==",
    "negated": false,
    "value": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "target": "<string>"
  },
  "groups": [
    "<string>"
  ],
  "sorts": [
    {
      "field": "<string>",
      "condition": {
        "combinator": "and",
        "conditions": [
          {}
        ],
        "field": "<string>",
        "operator": "==",
        "negated": true,
        "value": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "target": "<string>"
      },
      "direction": "ascending"
    }
  ],
  "limit": 123,
  "variables": [
    {
      "field": "<string>",
      "value": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "functions": [
    {
      "field": "<string>",
      "function": "<string>",
      "params": {}
    }
  ],
  "queries": [
    {}
  ],
  "aliases": {},
  "engine": "orm"
}'

{
  "items": [
    {
      "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "archived": true,
      "status": "TODO",
      "legacy_data": {},
      "skills": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "queue_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "queue_uid_expression": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "queue_uid_column": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "assignee_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "participants": {},
      "case_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "parent_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "due_at": "2023-11-07T05:31:56Z",
      "fields": {},
      "form_data": {},
      "form_type": "<string>",
      "assigned_at": "2023-11-07T05:31:56Z",
      "started_at": "2023-11-07T05:31:56Z",
      "done_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "assignee_updated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "queue_updated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_assigned_player": true,
      "internal_created_at": "2023-11-07T05:31:56Z",
      "internal_updated_at": "2023-11-07T05:31:56Z",
      "external_created_at": "2023-11-07T05:31:56Z",
      "external_updated_at": "2023-11-07T05:31:56Z",
      "external_status": "TODO",
      "external_status_updated_at": "2023-11-07T05:31:56Z",
      "external_assignee_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "queue_time": 123,
      "queue_time_business": 123,
      "work_time": 123,
      "work_time_business": 123,
      "incremental_work_time": 123,
      "incremental_work_time_business": 123,
      "resolution_time": 123,
      "resolution_time_business": 123,
      "num_children": 123,
      "num_children_done": 123,
      "sla_breach_at": "2023-11-07T05:31:56Z",
      "sla_breach_business_at": "2023-11-07T05:31:56Z",
      "wait_time": 123,
      "wait_time_business": 123,
      "played_at": "2023-11-07T05:31:56Z",
      "reviewer_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "review_form_data": {},
      "reviewed_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "before_cursor": "<string>",
    "after_cursor": "<string>"
  }
}

Introduction

Tasks

Comments

Authorizations

Headers

Query Parameters

Body

Response