Skip to content

Fixes #683 - Removed 'by ticket' from checklists endpoint and added hint how to get 'checklist ID' #685

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 4, 2025
Merged

Fixes #683 - Removed 'by ticket' from checklists endpoint and added hint how to get 'checklist ID' #685

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 2 additions & 89 deletions api/checklist/checklists.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,95 +40,8 @@ Response:
]
}

Show By Ticket
--------------

Required permission: ``ticket.agent``

``GET``-Request sent: ``/api/v1/checklists/by_ticket/{ticket id}``

Response:

.. code-block:: json
:force:

# HTTP-Code 200 OK

{
"id": 6,
"assets": {
"Checklist": {
"6": {
"name": "Return order",
"sorted_item_ids": [
"18",
"19",
"20",
"21"
],
"updated_by_id": 3,
"created_by_id": 3,
"ticket_id": 4,
"id": 6,
"created_at": "2024-10-15T08:47:50.860Z",
"updated_at": "2024-10-15T08:50:52.698Z",
"item_ids": [
18,
19,
20,
21
]
}
},
"ChecklistItem": {
"18": {
"text": "Prepare shipment",
"checked": false,
"updated_by_id": 3,
"ticket_id": null,
"created_by_id": 3,
"checklist_id": 6,
"id": 18,
"created_at": "2024-10-15T08:47:51.036Z",
"updated_at": "2024-10-15T08:47:59.717Z"
},
"19": {
"text": "Inform customer",
"checked": false,
"updated_by_id": 3,
"ticket_id": null,
"created_by_id": 3,
"checklist_id": 6,
"id": 19,
"created_at": "2024-10-15T08:48:02.042Z",
"updated_at": "2024-10-15T08:48:12.726Z"
},
"20": {
"text": "Hand over the goods to the shipping company",
"checked": false,
"updated_by_id": 3,
"ticket_id": null,
"created_by_id": 3,
"checklist_id": 6,
"id": 20,
"created_at": "2024-10-15T08:48:14.216Z",
"updated_at": "2024-10-15T08:49:10.467Z"
},
"21": {
"text": "Check whether return has arrived",
"checked": false,
"updated_by_id": 3,
"ticket_id": null,
"created_by_id": 3,
"checklist_id": 6,
"id": 21,
"created_at": "2024-10-15T08:49:12.388Z",
"updated_at": "2024-10-15T08:49:40.746Z"
}
}
}
}

.. hint:: You can find the ``checklist_id`` attribute of a ticket by sending a
``GET`` request to ``/api/v1/tickets/{ticket id}``.

Create
------
Expand Down