Skip to content

Commit a959c54

Browse files
authored
Fixes #683 - Removed 'by ticket' from checklists endpoint and added hint how to get 'checklist ID'
1 parent 9a65fe7 commit a959c54

File tree

1 file changed

+2
-89
lines changed

1 file changed

+2
-89
lines changed

api/checklist/checklists.rst

Lines changed: 2 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -40,95 +40,8 @@ Response:
4040
]
4141
}
4242
43-
Show By Ticket
44-
--------------
45-
46-
Required permission: ``ticket.agent``
47-
48-
``GET``-Request sent: ``/api/v1/checklists/by_ticket/{ticket id}``
49-
50-
Response:
51-
52-
.. code-block:: json
53-
:force:
54-
55-
# HTTP-Code 200 OK
56-
57-
{
58-
"id": 6,
59-
"assets": {
60-
"Checklist": {
61-
"6": {
62-
"name": "Return order",
63-
"sorted_item_ids": [
64-
"18",
65-
"19",
66-
"20",
67-
"21"
68-
],
69-
"updated_by_id": 3,
70-
"created_by_id": 3,
71-
"ticket_id": 4,
72-
"id": 6,
73-
"created_at": "2024-10-15T08:47:50.860Z",
74-
"updated_at": "2024-10-15T08:50:52.698Z",
75-
"item_ids": [
76-
18,
77-
19,
78-
20,
79-
21
80-
]
81-
}
82-
},
83-
"ChecklistItem": {
84-
"18": {
85-
"text": "Prepare shipment",
86-
"checked": false,
87-
"updated_by_id": 3,
88-
"ticket_id": null,
89-
"created_by_id": 3,
90-
"checklist_id": 6,
91-
"id": 18,
92-
"created_at": "2024-10-15T08:47:51.036Z",
93-
"updated_at": "2024-10-15T08:47:59.717Z"
94-
},
95-
"19": {
96-
"text": "Inform customer",
97-
"checked": false,
98-
"updated_by_id": 3,
99-
"ticket_id": null,
100-
"created_by_id": 3,
101-
"checklist_id": 6,
102-
"id": 19,
103-
"created_at": "2024-10-15T08:48:02.042Z",
104-
"updated_at": "2024-10-15T08:48:12.726Z"
105-
},
106-
"20": {
107-
"text": "Hand over the goods to the shipping company",
108-
"checked": false,
109-
"updated_by_id": 3,
110-
"ticket_id": null,
111-
"created_by_id": 3,
112-
"checklist_id": 6,
113-
"id": 20,
114-
"created_at": "2024-10-15T08:48:14.216Z",
115-
"updated_at": "2024-10-15T08:49:10.467Z"
116-
},
117-
"21": {
118-
"text": "Check whether return has arrived",
119-
"checked": false,
120-
"updated_by_id": 3,
121-
"ticket_id": null,
122-
"created_by_id": 3,
123-
"checklist_id": 6,
124-
"id": 21,
125-
"created_at": "2024-10-15T08:49:12.388Z",
126-
"updated_at": "2024-10-15T08:49:40.746Z"
127-
}
128-
}
129-
}
130-
}
131-
43+
.. hint:: You can find the ``checklist_id`` attribute of a ticket by sending a
44+
``GET`` request to ``/api/v1/tickets/{ticket id}``.
13245

13346
Create
13447
------

0 commit comments

Comments
 (0)