Switch to Zammad 6.1.

zammad · Sep 13, 2023 · e036b08 · e036b08
1 parent 435a7c9
commit e036b08
Show file tree

Hide file tree

Showing 25 changed files with 2,843 additions and 1,003 deletions.
diff --git a/api/organization.rst b/api/organization.rst
@@ -6,9 +6,9 @@ List
 
 Required permission: ``ticket.agent`` **or** ``admin.organization``
 
-   .. note:: 
+   .. note::
 
-      Technically any, customers can only see their own organization
+      Technically, customers can only see their own organization
       if applicable.
 
 ``GET``-Request sent: ``/api/v1/organizations``
@@ -31,47 +31,53 @@ Response:
          "note": "",
          "updated_by_id": 1,
          "created_by_id": 1,
-         "created_at": "2021-11-03T11:51:13.683Z",
-         "updated_at": "2021-11-03T11:51:13.822Z",
+         "created_at": "2023-07-26T08:44:39.608Z",
+         "updated_at": "2023-08-04T12:02:00.018Z",
+         "vip": false,
          "member_ids": [
             2
-         ]
+         ],
+         "secondary_member_ids": []
       },
       {
-         "id": 2,
          "name": "Chrispresso Inc.",
          "shared": true,
          "domain": "",
          "domain_assignment": false,
          "active": true,
          "note": "Manufacturer of individual coffee products.",
-         "updated_by_id": 1,
+         "vip": false,
+         "updated_by_id": 3,
+         "id": 2,
          "created_by_id": 1,
-         "created_at": "2021-11-03T11:57:15.817Z",
-         "updated_at": "2021-11-03T11:57:15.817Z",
+         "created_at": "2023-07-26T08:44:48.617Z",
+         "updated_at": "2023-08-04T12:01:44.370Z",
          "member_ids": [
+            3,
             5,
-            4,
-            3
-         ]
+            4
+         ],
+         "secondary_member_ids": []
       },
       {
-         "id": 3,
          "name": "Awesome Customer Inc.",
          "shared": true,
          "domain": "",
          "domain_assignment": false,
          "active": true,
          "note": "Global distributor of communication and security products, electrical and electronic wire &amp; cable.",
-         "updated_by_id": 1,
+         "vip": true,
+         "updated_by_id": 3,
+         "id": 3,
          "created_by_id": 1,
-         "created_at": "2021-11-03T11:57:15.825Z",
-         "updated_at": "2021-11-03T11:57:15.825Z",
+         "created_at": "2023-07-26T08:44:48.632Z",
+         "updated_at": "2023-08-04T12:54:30.974Z",
          "member_ids": [
             8,
             7,
             6
-         ]
+         ],
+         "secondary_member_ids": []
       },
       {
          "id": 4,
@@ -83,25 +89,12 @@ Response:
          "note": "Search the world's information, including webpages, images, videos and more. Good Customer has many special features to help you find exactly what you're looking for.",
          "updated_by_id": 1,
          "created_by_id": 1,
-         "created_at": "2021-11-03T11:57:15.839Z",
-         "updated_at": "2021-11-03T11:57:15.839Z",
+         "created_at": "2023-07-26T08:44:48.645Z",
+         "updated_at": "2023-07-26T08:44:48.645Z",
          "member_ids": [
             9
-         ]
-      },
-      {
-         "id": 5,
-         "name": "Test",
-         "shared": true,
-         "domain": "",
-         "domain_assignment": false,
-         "active": true,
-         "note": "",
-         "updated_by_id": 3,
-         "created_by_id": 3,
-         "created_at": "2021-11-03T14:42:28.555Z",
-         "updated_at": "2021-11-03T15:04:03.149Z",
-         "member_ids": []
+         ],
+         "secondary_member_ids": []
       }
    ]
 
@@ -124,56 +117,61 @@ Response:
 
    [
       {
-         "id": 4,
-         "name": "Good Customer Inc.",
+         "name": "Awesome Customer Inc.",
          "shared": true,
          "domain": "",
          "domain_assignment": false,
          "active": true,
-         "note": "Search the world's information, including webpages, images, videos and more. Good Customer has many special features to help you find exactly what you're looking for.",
-         "updated_by_id": 1,
+         "note": "Global distributor of communication and security products, electrical and electronic wire &amp; cable.",
+         "vip": true,
+         "updated_by_id": 3,
+         "id": 3,
          "created_by_id": 1,
-         "created_at": "2021-11-03T11:57:15.839Z",
-         "updated_at": "2021-11-03T11:57:15.839Z",
+         "created_at": "2023-07-26T08:44:48.632Z",
+         "updated_at": "2023-08-04T12:54:30.974Z",
          "member_ids": [
-            9
-         ]
+            8,
+            7,
+            6
+         ],
+         "secondary_member_ids": []
       },
       {
-         "id": 3,
-         "name": "Awesome Customer Inc.",
+         "name": "Chrispresso Inc.",
          "shared": true,
          "domain": "",
          "domain_assignment": false,
          "active": true,
-         "note": "Global distributor of communication and security products, electrical and electronic wire &amp; cable.",
-         "updated_by_id": 1,
+         "note": "Manufacturer of individual coffee products.",
+         "vip": false,
+         "updated_by_id": 3,
+         "id": 2,
          "created_by_id": 1,
-         "created_at": "2021-11-03T11:57:15.825Z",
-         "updated_at": "2021-11-03T11:57:15.825Z",
+         "created_at": "2023-07-26T08:44:48.617Z",
+         "updated_at": "2023-08-04T12:01:44.370Z",
          "member_ids": [
-            8,
-            7,
-            6
-         ]
+            3,
+            5,
+            4
+         ],
+         "secondary_member_ids": []
       },
       {
-         "id": 2,
-         "name": "Chrispresso Inc.",
+         "id": 4,
+         "name": "Good Customer Inc.",
          "shared": true,
          "domain": "",
          "domain_assignment": false,
          "active": true,
-         "note": "Manufacturer of individual coffee products.",
+         "note": "Search the world's information, including webpages, images, videos and more. Good Customer has many special features to help you find exactly what you're looking for.",
          "updated_by_id": 1,
          "created_by_id": 1,
-         "created_at": "2021-11-03T11:57:15.817Z",
-         "updated_at": "2021-11-03T11:57:15.817Z",
+         "created_at": "2023-07-26T08:44:48.645Z",
+         "updated_at": "2023-07-26T08:44:48.645Z",
          "member_ids": [
-            5,
-            4,
-            3
-         ]
+            9
+         ],
+         "secondary_member_ids": []
       }
    ]
 
@@ -182,9 +180,9 @@ Show
 
 Required permission: ``ticket.agent`` **or** ``admin.organization``
 
-   .. note:: 
+   .. note::
 
-      Technically any - users in question can only see their own organization.
+      Technically any users in question can only see their own organization.
 
 ``GET``-Request sent: ``/api/v1/organizations/{id}``
 
@@ -203,15 +201,17 @@ Response:
       "domain_assignment": false,
       "active": true,
       "note": "Manufacturer of individual coffee products.",
-      "updated_by_id": 1,
+      "vip": false,
+      "updated_by_id": 3,
       "created_by_id": 1,
-      "created_at": "2021-11-03T11:57:15.817Z",
-      "updated_at": "2021-11-03T11:57:15.817Z",
+      "created_at": "2023-07-26T08:44:48.617Z",
+      "updated_at": "2023-08-04T12:01:44.370Z",
       "member_ids": [
+         3,
          5,
-         4,
-         3
-      ]
+         4
+      ],
+      "secondary_member_ids": []
    }
 
 Create
@@ -229,14 +229,15 @@ Required permission: ``admin.organization``
       "domain": "example.com",
       "domain_assignment": true,
       "active": true,
+      "vip": true,
       "note": "Just a sample, aint that nice?",
       "members": [
          "olivia@example.com",
-         "jdoe",
          "david@example.com"
       ]
    }
 
+
 Response:
 
 .. code-block:: json
@@ -245,7 +246,7 @@ Response:
    # HTTP-Code 201 Created
 
    {
-      "id": 6,
+      "id": 5,
       "name": "Sample Corp.",
       "shared": false,
       "domain": "example.com",
@@ -254,13 +255,14 @@ Response:
       "note": "Just a sample, aint that nice?",
       "updated_by_id": 3,
       "created_by_id": 3,
-      "created_at": "2021-11-03T17:38:39.527Z",
-      "updated_at": "2021-11-03T17:38:39.768Z",
+      "created_at": "2023-08-08T09:12:42.023Z",
+      "updated_at": "2023-08-08T09:12:42.602Z",
+      "vip": true,
       "member_ids": [
          10,
-         16,
          11
-      ]
+      ],
+      "secondary_member_ids": []
    }
 
 Update
@@ -278,7 +280,7 @@ Required permission: ``admin.organization``
       "domain": "",
       "domain_assignment": false,
       "active": true,
-      "note": "This was a triump - I'm making a note here - H-U-G-E success!",
+      "note": "This was a triumph - I'm making a note here - H-U-G-E success!",
       "members": [
          "olivia@example.com",
          "david@example.com"
@@ -293,23 +295,25 @@ Response:
    # HTTP-Code 200 Ok
 
    {
-      "id": 6,
+      "id": 5,
       "name": "Sample Corp.",
       "shared": false,
       "domain": "",
       "domain_assignment": false,
       "active": true,
-      "note": "This was a triump - I'm making a note here - H-U-G-E success!",
+      "note": "This was a triumph - I'm making a note here - H-U-G-E success!",
       "updated_by_id": 3,
       "created_by_id": 3,
-      "created_at": "2021-11-03T17:38:39.527Z",
-      "updated_at": "2021-11-03T17:40:59.740Z",
+      "created_at": "2023-08-08T09:12:42.023Z",
+      "updated_at": "2023-08-08T09:16:58.922Z",
+      "vip": true,
       "member_ids": [
-         11,
-         10
-      ]
+         10,
+         11
+      ],
+      "secondary_member_ids": []
    }
-
+   
 Delete
 ======
 

diff --git a/api/ticket.rst b/api/ticket.rst
@@ -1,17 +1,19 @@
-Ticket endpoints
+Ticket Endpoints
 ================
 
-Zammad comes with many ticket related endpoints. 
-For better overview the grouped those up:
+Zammad comes with many ticket related endpoints.
+For better overview, they have been splitted in different sections:
 
    .. toctree::
       :maxdepth: 1
       :glob:
 
-      /api/ticket/index
       /api/ticket/articles
+      /api/ticket/links
+      /api/ticket/mentions
       /api/ticket/priorities
+      /api/ticket/shared_drafts
       /api/ticket/states
       /api/ticket/tags
-      /api/ticket/links
-      /api/ticket/mentions
+      /api/ticket/index
+      /api/ticket/timeaccounting