List

GET

/operations/operations_tasks/list/v1

GET

/operations/operations_tasks/list/v1

1 import { ChrtClient } from "@chrt-inc/typescript-sdk";
2 
3 async function main() {
4     const client = new ChrtClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.operations.operationsTasks.listV1({
8         filter_assigned_user_id: "filter_assigned_user_id",
9         filter_deadline_gte: "2024-01-15T09:30:00Z",
10         filter_deadline_lte: "2024-01-15T09:30:00Z",
11         filter_department_id: "filter_department_id",
12         filter_order_ids: [
13             "filter_order_ids",
14         ],
15         filter_order_off_chrt_reference_id: "filter_order_off_chrt_reference_id",
16         filter_order_short_id: "filter_order_short_id",
17         filter_source_task_list_id: "filter_source_task_list_id",
18         filter_status: [
19             "not_started",
20         ],
21         filter_task_type: [
22             "review_order_details",
23         ],
24         page: 1,
25         page_size: 1,
26         search: "search",
27         sort_by: "deadline_timestamp",
28         sort_order: "asc",
29     });
30 }
31 main();

1 {
2   "items": [
3     {
4       "_id": "_id",
5       "description": "description",
6       "order_id": "order_id",
7       "order_short_id": "order_short_id",
8       "org_id": "org_id",
9       "schema_version": 1,
10       "task_type": "review_order_details",
11       "title": "title",
12       "assigned_user_ids": [
13         "assigned_user_ids"
14       ],
15       "comments": [
16         {
17           "comment": "comment",
18           "timestamp": "2024-01-15T09:30:00Z",
19           "user_id": "user_id"
20         }
21       ],
22       "completed_at_timestamp": "2024-01-15T09:30:00Z",
23       "completed_by_user_id": "completed_by_user_id",
24       "deadline_timestamp": "2024-01-15T09:30:00Z",
25       "department_id": "department_id",
26       "order_off_chrt_reference_id": "order_off_chrt_reference_id",
27       "source_task_list_id": "source_task_list_id",
28       "status": "not_started"
29     }
30   ],
31   "total_count": 1
32 }

Lists OperationsTasks for the caller’s organization, with order ids / order short id / order off-CHRT reference id / department / type / status / assignee / source task list / deadline filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (OperationsTaskListRes)

Authentication

AuthorizationBearer

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

Query parameters

sort_byenumOptional

Field to sort by

Allowed values:

sort_orderenumOptional

Sort order (asc or desc)

Allowed values:

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

searchstringOptional

Search by title or description

filter_order_idsstringOptional

Filter to tasks on any of these order ids (e.g. the order_ids returned by the orders typeahead for a chosen short_id / off-chrt reference id)

filter_order_short_idstringOptional

Filter to tasks for this order short ID

filter_order_off_chrt_reference_idstringOptionalformat: "^[A-Za-z0-9._~\-]{1,64}$"1-64 characters

Filter to tasks for this order off-CHRT reference ID

filter_department_idstringOptional

Filter to tasks routed to this department (desk queue)

filter_task_typeenumOptional

Filter by task type(s). Defaults to all types.

filter_statusenumOptional

Filter by status(es). Defaults to all statuses.

Allowed values:

filter_assigned_user_idstringOptional

Filter to tasks this user is directly assigned to

filter_source_task_list_idstringOptional

Filter to tasks created from this OperationsTaskList

filter_deadline_gtedatetimeOptional

Filter to tasks with deadline >= this timestamp

filter_deadline_ltedatetimeOptional

Filter to tasks with deadline <= this timestamp

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Operations Tasks List V1request Unprocessable Entity Error