@manyos/smileconnect-api 1.38.0 → 1.39.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/docs/openapi.json CHANGED
@@ -1565,120 +1565,6 @@
1565
1565
  }
1566
1566
  ]
1567
1567
  },
1568
- "/changes/{id}/tasks": {
1569
- "get": {
1570
- "tags": [
1571
- "Changes",
1572
- "Tasks"
1573
- ],
1574
- "responses": {
1575
- "200": {
1576
- "content": {
1577
- "application/json": {
1578
- "schema": {
1579
- "$ref": "#/components/schemas/TaskResponseList"
1580
- }
1581
- }
1582
- },
1583
- "description": "Get all tasks of a change"
1584
- }
1585
- },
1586
- "summary": "Get all tasks of a change"
1587
- },
1588
- "post": {
1589
- "requestBody": {
1590
- "content": {
1591
- "application/json": {
1592
- "schema": {
1593
- "$ref": "#/components/schemas/TaskRequest"
1594
- }
1595
- }
1596
- },
1597
- "required": true
1598
- },
1599
- "tags": [
1600
- "Changes",
1601
- "Tasks"
1602
- ],
1603
- "responses": {
1604
- "200": {
1605
- "content": {
1606
- "application/json": {
1607
- "schema": {
1608
- "$ref": "#/components/schemas/TaskResponseSingle"
1609
- }
1610
- }
1611
- },
1612
- "description": "Return the new change task"
1613
- }
1614
- },
1615
- "summary": "Add a task to a change"
1616
- },
1617
- "parameters": [
1618
- {
1619
- "examples": {
1620
- "id": {
1621
- "value": "CRQ12345"
1622
- }
1623
- },
1624
- "name": "id",
1625
- "schema": {
1626
- "type": "string"
1627
- },
1628
- "in": "path",
1629
- "required": true
1630
- }
1631
- ]
1632
- },
1633
- "/changes/{id}/tasks/{taskId}": {
1634
- "get": {
1635
- "tags": [
1636
- "Changes",
1637
- "Tasks"
1638
- ],
1639
- "responses": {
1640
- "200": {
1641
- "content": {
1642
- "application/json": {
1643
- "schema": {
1644
- "$ref": "#/components/schemas/TaskResponseList"
1645
- }
1646
- }
1647
- },
1648
- "description": "Get a specific task of a change"
1649
- }
1650
- },
1651
- "summary": "Get a specific task of a change"
1652
- },
1653
- "parameters": [
1654
- {
1655
- "examples": {
1656
- "id": {
1657
- "value": "CRQ12345"
1658
- }
1659
- },
1660
- "name": "id",
1661
- "schema": {
1662
- "type": "string"
1663
- },
1664
- "in": "path",
1665
- "required": true
1666
- },
1667
- {
1668
- "examples": {
1669
- "taskId": {
1670
- "value": "TAS1234"
1671
- }
1672
- },
1673
- "name": "taskId",
1674
- "schema": {
1675
- "type": "string"
1676
- },
1677
- "in": "path",
1678
- "required": true
1679
- }
1680
- ]
1681
- },
1682
1568
  "/changes/{id}/tasks/{taskId}/worklogs": {
1683
1569
  "get": {
1684
1570
  "tags": [
@@ -1822,32 +1708,33 @@
1822
1708
  }
1823
1709
  ]
1824
1710
  },
1825
- "/incidents/{id}/tasks": {
1711
+ "/incidents/{id}/tasks/{taskId}/worklogs": {
1826
1712
  "get": {
1827
1713
  "tags": [
1828
1714
  "Incidents",
1829
- "Tasks"
1715
+ "Tasks",
1716
+ "Worklogs"
1830
1717
  ],
1831
1718
  "responses": {
1832
1719
  "200": {
1833
1720
  "content": {
1834
1721
  "application/json": {
1835
1722
  "schema": {
1836
- "$ref": "#/components/schemas/TaskResponseList"
1723
+ "$ref": "#/components/schemas/WorklogResponseList"
1837
1724
  }
1838
1725
  }
1839
1726
  },
1840
- "description": "Get all tasks of an incident"
1727
+ "description": "get all worklogs of an incident task"
1841
1728
  }
1842
1729
  },
1843
- "summary": "Get all tasks of an incident"
1730
+ "summary": "Get all worklogs of an incident task"
1844
1731
  },
1845
1732
  "post": {
1846
1733
  "requestBody": {
1847
1734
  "content": {
1848
1735
  "application/json": {
1849
1736
  "schema": {
1850
- "$ref": "#/components/schemas/TaskRequest"
1737
+ "$ref": "#/components/schemas/WorklogRequest"
1851
1738
  }
1852
1739
  }
1853
1740
  },
@@ -1855,21 +1742,22 @@
1855
1742
  },
1856
1743
  "tags": [
1857
1744
  "Incidents",
1858
- "Tasks"
1745
+ "Tasks",
1746
+ "Worklogs"
1859
1747
  ],
1860
1748
  "responses": {
1861
1749
  "200": {
1862
1750
  "content": {
1863
1751
  "application/json": {
1864
1752
  "schema": {
1865
- "$ref": "#/components/schemas/TaskResponseSingle"
1753
+ "$ref": "#/components/schemas/WorklogResponseSingle"
1866
1754
  }
1867
1755
  }
1868
1756
  },
1869
- "description": "Return the new incident task"
1757
+ "description": "Returns the created worklog"
1870
1758
  }
1871
1759
  },
1872
- "summary": "Add a task to an incident"
1760
+ "summary": "Add a worklog to an incident task"
1873
1761
  },
1874
1762
  "parameters": [
1875
1763
  {
@@ -1884,35 +1772,49 @@
1884
1772
  },
1885
1773
  "in": "path",
1886
1774
  "required": true
1775
+ },
1776
+ {
1777
+ "examples": {
1778
+ "taskId": {
1779
+ "value": "TAS1234"
1780
+ }
1781
+ },
1782
+ "name": "taskId",
1783
+ "schema": {
1784
+ "type": "string"
1785
+ },
1786
+ "in": "path",
1787
+ "required": true
1887
1788
  }
1888
1789
  ]
1889
1790
  },
1890
- "/problems/{id}/tasks": {
1791
+ "/problems/{id}/tasks/{taskId}/worklogs": {
1891
1792
  "get": {
1892
1793
  "tags": [
1893
1794
  "Problems",
1894
- "Tasks"
1795
+ "Tasks",
1796
+ "Worklogs"
1895
1797
  ],
1896
1798
  "responses": {
1897
1799
  "200": {
1898
1800
  "content": {
1899
1801
  "application/json": {
1900
1802
  "schema": {
1901
- "$ref": "#/components/schemas/TaskResponseList"
1803
+ "$ref": "#/components/schemas/WorklogResponseList"
1902
1804
  }
1903
1805
  }
1904
1806
  },
1905
- "description": "Get all tasks of a problem"
1807
+ "description": "get all worklogs of a problem task"
1906
1808
  }
1907
1809
  },
1908
- "summary": "Get all tasks of a problem"
1810
+ "summary": "Get all worklogs of a problem task"
1909
1811
  },
1910
1812
  "post": {
1911
1813
  "requestBody": {
1912
1814
  "content": {
1913
1815
  "application/json": {
1914
1816
  "schema": {
1915
- "$ref": "#/components/schemas/TaskRequest"
1817
+ "$ref": "#/components/schemas/WorklogRequest"
1916
1818
  }
1917
1819
  }
1918
1820
  },
@@ -1920,21 +1822,22 @@
1920
1822
  },
1921
1823
  "tags": [
1922
1824
  "Problems",
1923
- "Tasks"
1825
+ "Tasks",
1826
+ "Worklogs"
1924
1827
  ],
1925
1828
  "responses": {
1926
1829
  "200": {
1927
1830
  "content": {
1928
1831
  "application/json": {
1929
1832
  "schema": {
1930
- "$ref": "#/components/schemas/TaskResponseSingle"
1833
+ "$ref": "#/components/schemas/WorklogResponseSingle"
1931
1834
  }
1932
1835
  }
1933
1836
  },
1934
- "description": "Return the new problem task"
1837
+ "description": "Returns the created worklog"
1935
1838
  }
1936
1839
  },
1937
- "summary": "Add a task to a problem"
1840
+ "summary": "Add a worklog to a problem task"
1938
1841
  },
1939
1842
  "parameters": [
1940
1843
  {
@@ -1949,35 +1852,49 @@
1949
1852
  },
1950
1853
  "in": "path",
1951
1854
  "required": true
1855
+ },
1856
+ {
1857
+ "examples": {
1858
+ "taskId": {
1859
+ "value": "TAS1234"
1860
+ }
1861
+ },
1862
+ "name": "taskId",
1863
+ "schema": {
1864
+ "type": "string"
1865
+ },
1866
+ "in": "path",
1867
+ "required": true
1952
1868
  }
1953
1869
  ]
1954
1870
  },
1955
- "/workorders/{id}/tasks": {
1871
+ "/workorders/{id}/tasks/{taskId}/worklogs": {
1956
1872
  "get": {
1957
1873
  "tags": [
1958
1874
  "Workorders",
1959
- "Tasks"
1875
+ "Tasks",
1876
+ "Worklogs"
1960
1877
  ],
1961
1878
  "responses": {
1962
1879
  "200": {
1963
1880
  "content": {
1964
1881
  "application/json": {
1965
1882
  "schema": {
1966
- "$ref": "#/components/schemas/TaskResponseList"
1883
+ "$ref": "#/components/schemas/WorklogResponseList"
1967
1884
  }
1968
1885
  }
1969
1886
  },
1970
- "description": "Get all tasks of a work order"
1887
+ "description": "get all worklogs of a workorder task"
1971
1888
  }
1972
1889
  },
1973
- "summary": "Get all tasks of a work order"
1890
+ "summary": "Get all worklogs of a workorder task"
1974
1891
  },
1975
1892
  "post": {
1976
1893
  "requestBody": {
1977
1894
  "content": {
1978
1895
  "application/json": {
1979
1896
  "schema": {
1980
- "$ref": "#/components/schemas/TaskRequest"
1897
+ "$ref": "#/components/schemas/WorklogRequest"
1981
1898
  }
1982
1899
  }
1983
1900
  },
@@ -1985,21 +1902,22 @@
1985
1902
  },
1986
1903
  "tags": [
1987
1904
  "Workorders",
1988
- "Tasks"
1905
+ "Tasks",
1906
+ "Worklogs"
1989
1907
  ],
1990
1908
  "responses": {
1991
1909
  "200": {
1992
1910
  "content": {
1993
1911
  "application/json": {
1994
1912
  "schema": {
1995
- "$ref": "#/components/schemas/TaskResponseSingle"
1913
+ "$ref": "#/components/schemas/WorklogResponseSingle"
1996
1914
  }
1997
1915
  }
1998
1916
  },
1999
- "description": "Return the new work order task"
1917
+ "description": "Returns the created worklog"
2000
1918
  }
2001
1919
  },
2002
- "summary": "Add a task to a work order"
1920
+ "summary": "Add a worklog to a workorder task"
2003
1921
  },
2004
1922
  "parameters": [
2005
1923
  {
@@ -2014,28 +1932,42 @@
2014
1932
  },
2015
1933
  "in": "path",
2016
1934
  "required": true
1935
+ },
1936
+ {
1937
+ "examples": {
1938
+ "taskId": {
1939
+ "value": "TAS1234"
1940
+ }
1941
+ },
1942
+ "name": "taskId",
1943
+ "schema": {
1944
+ "type": "string"
1945
+ },
1946
+ "in": "path",
1947
+ "required": true
2017
1948
  }
2018
1949
  ]
2019
1950
  },
2020
- "/incidents/{id}/tasks/{taskId}": {
1951
+ "/incidents/{id}/tasks/{taskId}/worklogs/{worklogId}": {
2021
1952
  "get": {
2022
1953
  "tags": [
1954
+ "Tasks",
2023
1955
  "Incidents",
2024
- "Tasks"
1956
+ "Worklogs"
2025
1957
  ],
2026
1958
  "responses": {
2027
1959
  "200": {
2028
1960
  "content": {
2029
1961
  "application/json": {
2030
1962
  "schema": {
2031
- "$ref": "#/components/schemas/TaskResponseList"
1963
+ "$ref": "#/components/schemas/WorklogResponseSingle"
2032
1964
  }
2033
1965
  }
2034
1966
  },
2035
- "description": "Get a specific task of an Incident"
1967
+ "description": "Get a specific task worklog"
2036
1968
  }
2037
1969
  },
2038
- "summary": "Get a specific task of a Incident"
1970
+ "summary": "Get a specific worklog of an incident task"
2039
1971
  },
2040
1972
  "parameters": [
2041
1973
  {
@@ -2063,28 +1995,42 @@
2063
1995
  },
2064
1996
  "in": "path",
2065
1997
  "required": true
1998
+ },
1999
+ {
2000
+ "examples": {
2001
+ "worklogId": {
2002
+ "value": "WLG00391234"
2003
+ }
2004
+ },
2005
+ "name": "worklogId",
2006
+ "schema": {
2007
+ "type": "string"
2008
+ },
2009
+ "in": "path",
2010
+ "required": true
2066
2011
  }
2067
2012
  ]
2068
2013
  },
2069
- "/problems/{id}/tasks/{taskId}": {
2014
+ "/problems/{id}/tasks/{taskId}/worklogs/{worklogId}": {
2070
2015
  "get": {
2071
2016
  "tags": [
2017
+ "Tasks",
2072
2018
  "Problems",
2073
- "Tasks"
2019
+ "Worklogs"
2074
2020
  ],
2075
2021
  "responses": {
2076
2022
  "200": {
2077
2023
  "content": {
2078
2024
  "application/json": {
2079
2025
  "schema": {
2080
- "$ref": "#/components/schemas/TaskResponseList"
2026
+ "$ref": "#/components/schemas/WorklogResponseSingle"
2081
2027
  }
2082
2028
  }
2083
2029
  },
2084
- "description": "Get a specific task of a problem"
2030
+ "description": "Get a specific task worklog"
2085
2031
  }
2086
2032
  },
2087
- "summary": "Get a specific task of a problem"
2033
+ "summary": "Get a specific worklog of a problem task"
2088
2034
  },
2089
2035
  "parameters": [
2090
2036
  {
@@ -2112,28 +2058,42 @@
2112
2058
  },
2113
2059
  "in": "path",
2114
2060
  "required": true
2115
- }
2116
- ]
2117
- },
2118
- "/workorders/{id}/tasks/{taskId}": {
2061
+ },
2062
+ {
2063
+ "examples": {
2064
+ "worklogId": {
2065
+ "value": "WLG00391234"
2066
+ }
2067
+ },
2068
+ "name": "worklogId",
2069
+ "schema": {
2070
+ "type": "string"
2071
+ },
2072
+ "in": "path",
2073
+ "required": true
2074
+ }
2075
+ ]
2076
+ },
2077
+ "/workorders/{id}/tasks/{taskId}/worklogs/{worklogId}": {
2119
2078
  "get": {
2120
2079
  "tags": [
2080
+ "Tasks",
2121
2081
  "Workorders",
2122
- "Tasks"
2082
+ "Worklogs"
2123
2083
  ],
2124
2084
  "responses": {
2125
2085
  "200": {
2126
2086
  "content": {
2127
2087
  "application/json": {
2128
2088
  "schema": {
2129
- "$ref": "#/components/schemas/TaskResponseList"
2089
+ "$ref": "#/components/schemas/WorklogResponseSingle"
2130
2090
  }
2131
2091
  }
2132
2092
  },
2133
- "description": "Get a specific task of a Workorder"
2093
+ "description": "Get a specific task worklog"
2134
2094
  }
2135
2095
  },
2136
- "summary": "Get a specific task of a Workorder"
2096
+ "summary": "Get a specific worklog of a workorder task"
2137
2097
  },
2138
2098
  "parameters": [
2139
2099
  {
@@ -2161,68 +2121,73 @@
2161
2121
  },
2162
2122
  "in": "path",
2163
2123
  "required": true
2124
+ },
2125
+ {
2126
+ "examples": {
2127
+ "worklogId": {
2128
+ "value": "WLG00391234"
2129
+ }
2130
+ },
2131
+ "name": "worklogId",
2132
+ "schema": {
2133
+ "type": "string"
2134
+ },
2135
+ "in": "path",
2136
+ "required": true
2164
2137
  }
2165
2138
  ]
2166
2139
  },
2167
- "/incidents/{id}/tasks/{taskId}/worklogs": {
2140
+ "/appconfig/forms": {
2168
2141
  "get": {
2169
2142
  "tags": [
2170
- "Incidents",
2171
- "Tasks",
2172
- "Worklogs"
2143
+ "AppConfig"
2173
2144
  ],
2174
2145
  "responses": {
2175
2146
  "200": {
2176
2147
  "content": {
2177
2148
  "application/json": {
2178
2149
  "schema": {
2179
- "$ref": "#/components/schemas/WorklogResponseList"
2150
+ "type": "array",
2151
+ "items": {
2152
+ "type": "string"
2153
+ }
2180
2154
  }
2181
2155
  }
2182
2156
  },
2183
- "description": "get all worklogs of an incident task"
2157
+ "description": "Return all forms"
2184
2158
  }
2185
- },
2186
- "summary": "Get all worklogs of an incident task"
2187
- },
2188
- "post": {
2189
- "requestBody": {
2190
- "content": {
2191
- "application/json": {
2192
- "schema": {
2193
- "$ref": "#/components/schemas/WorklogRequest"
2194
- }
2195
- }
2196
- },
2197
- "required": true
2198
- },
2159
+ }
2160
+ }
2161
+ },
2162
+ "/appconfig/forms/{id}/fields": {
2163
+
2164
+ },
2165
+ "/templates/{templateType}": {
2166
+ "get": {
2199
2167
  "tags": [
2168
+ "Templates",
2169
+ "Changes",
2200
2170
  "Incidents",
2171
+ "Problems",
2201
2172
  "Tasks",
2202
- "Worklogs"
2173
+ "Workorders"
2203
2174
  ],
2204
2175
  "responses": {
2205
2176
  "200": {
2206
- "content": {
2207
- "application/json": {
2208
- "schema": {
2209
- "$ref": "#/components/schemas/WorklogResponseSingle"
2210
- }
2211
- }
2212
- },
2213
- "description": "Returns the created worklog"
2177
+ "$ref": "#/components/responses/TemplateResponseArray"
2214
2178
  }
2215
2179
  },
2216
- "summary": "Add a worklog to an incident task"
2180
+ "summary": "Get all templates of a specific type"
2217
2181
  },
2218
2182
  "parameters": [
2219
2183
  {
2220
2184
  "examples": {
2221
- "id": {
2222
- "value": "INC12345"
2185
+ "templatetyp": {
2186
+ "value": "incidents"
2223
2187
  }
2224
2188
  },
2225
- "name": "id",
2189
+ "name": "templateType",
2190
+ "description": "The template type. Possible values:\n\nincidents\nproblems\nchanges\nworkorders\ntasks",
2226
2191
  "schema": {
2227
2192
  "type": "string"
2228
2193
  },
@@ -2230,79 +2195,51 @@
2230
2195
  "required": true
2231
2196
  },
2232
2197
  {
2233
- "examples": {
2234
- "taskId": {
2235
- "value": "TAS1234"
2236
- }
2198
+ "name": "limit",
2199
+ "description": "limit the number of results returned",
2200
+ "schema": {
2201
+ "type": "integer"
2237
2202
  },
2238
- "name": "taskId",
2203
+ "in": "query",
2204
+ "required": false
2205
+ },
2206
+ {
2207
+ "name": "offset",
2208
+ "description": "offset used for pagination together with limit",
2239
2209
  "schema": {
2240
- "type": "string"
2210
+ "type": "integer"
2241
2211
  },
2242
- "in": "path",
2243
- "required": true
2212
+ "in": "query",
2213
+ "required": false
2244
2214
  }
2245
2215
  ]
2246
2216
  },
2247
- "/problems/{id}/tasks/{taskId}/worklogs": {
2217
+ "/templates/{templateType}/{id}": {
2248
2218
  "get": {
2249
2219
  "tags": [
2220
+ "Templates",
2221
+ "Changes",
2222
+ "Incidents",
2250
2223
  "Problems",
2251
2224
  "Tasks",
2252
- "Worklogs"
2253
- ],
2254
- "responses": {
2255
- "200": {
2256
- "content": {
2257
- "application/json": {
2258
- "schema": {
2259
- "$ref": "#/components/schemas/WorklogResponseList"
2260
- }
2261
- }
2262
- },
2263
- "description": "get all worklogs of a problem task"
2264
- }
2265
- },
2266
- "summary": "Get all worklogs of a problem task"
2267
- },
2268
- "post": {
2269
- "requestBody": {
2270
- "content": {
2271
- "application/json": {
2272
- "schema": {
2273
- "$ref": "#/components/schemas/WorklogRequest"
2274
- }
2275
- }
2276
- },
2277
- "required": true
2278
- },
2279
- "tags": [
2280
- "Problems",
2281
- "Tasks",
2282
- "Worklogs"
2225
+ "Workorders"
2283
2226
  ],
2284
2227
  "responses": {
2285
2228
  "200": {
2286
- "content": {
2287
- "application/json": {
2288
- "schema": {
2289
- "$ref": "#/components/schemas/WorklogResponseSingle"
2290
- }
2291
- }
2292
- },
2293
- "description": "Returns the created worklog"
2229
+ "$ref": "#/components/responses/TemplateResponseSingle"
2294
2230
  }
2295
2231
  },
2296
- "summary": "Add a worklog to a problem task"
2232
+ "summary": "Get a specific template"
2297
2233
  },
2298
2234
  "parameters": [
2299
2235
  {
2300
2236
  "examples": {
2301
- "id": {
2302
- "value": "PBI12345"
2237
+ "templatetyp": {
2238
+ "value": "incidents"
2303
2239
  }
2304
2240
  },
2305
- "name": "id",
2241
+ "name": "templateType",
2242
+ "description": "The template type. Possible values:\n\nincidents\nproblems\nchanges\nworkorders\ntasks",
2306
2243
  "schema": {
2307
2244
  "type": "string"
2308
2245
  },
@@ -2311,11 +2248,12 @@
2311
2248
  },
2312
2249
  {
2313
2250
  "examples": {
2314
- "taskId": {
2315
- "value": "TAS1234"
2251
+ "templatetyp": {
2252
+ "value": "AG029ed9200194dcnlas991"
2316
2253
  }
2317
2254
  },
2318
- "name": "taskId",
2255
+ "name": "id",
2256
+ "description": "The id of the template",
2319
2257
  "schema": {
2320
2258
  "type": "string"
2321
2259
  },
@@ -2324,378 +2262,591 @@
2324
2262
  }
2325
2263
  ]
2326
2264
  },
2327
- "/workorders/{id}/tasks/{taskId}/worklogs": {
2265
+ "/persons": {
2328
2266
  "get": {
2329
2267
  "tags": [
2330
- "Workorders",
2331
- "Tasks",
2332
- "Worklogs"
2268
+ "Foundation"
2333
2269
  ],
2334
2270
  "responses": {
2335
2271
  "200": {
2336
2272
  "content": {
2337
2273
  "application/json": {
2338
2274
  "schema": {
2339
- "$ref": "#/components/schemas/WorklogResponseList"
2275
+ "$ref": "#/components/schemas/PersonResponseList"
2340
2276
  }
2341
2277
  }
2342
2278
  },
2343
- "description": "get all worklogs of a workorder task"
2279
+ "description": "Return an array of persons that are accessible with the defined basequery.\n\nNote: supportGroups are only included in single person requests."
2344
2280
  }
2345
2281
  },
2346
- "summary": "Get all worklogs of a workorder task"
2282
+ "summary": "Get all persons"
2347
2283
  },
2348
- "post": {
2349
- "requestBody": {
2350
- "content": {
2351
- "application/json": {
2352
- "schema": {
2353
- "$ref": "#/components/schemas/WorklogRequest"
2354
- }
2284
+ "parameters": [
2285
+ {
2286
+ "examples": {
2287
+ "include": {
2288
+ "value": "groupMembership"
2355
2289
  }
2356
2290
  },
2357
- "required": true
2291
+ "name": "include",
2292
+ "description": "Defines if and which related objects shoudl be included.\nPossible values: groupMembership",
2293
+ "schema": {
2294
+ "type": "array",
2295
+ "items": {
2296
+ "type": "string"
2297
+ }
2298
+ },
2299
+ "in": "query",
2300
+ "required": false
2301
+ },
2302
+ {
2303
+ "name": "limit",
2304
+ "description": "limit the number of results returned",
2305
+ "schema": {
2306
+ "type": "integer"
2307
+ },
2308
+ "in": "query",
2309
+ "required": false
2358
2310
  },
2311
+ {
2312
+ "name": "offset",
2313
+ "description": "offset used for pagination together with limit",
2314
+ "schema": {
2315
+ "type": "integer"
2316
+ },
2317
+ "in": "query",
2318
+ "required": false
2319
+ }
2320
+ ]
2321
+ },
2322
+ "/organisations/": {
2323
+ "get": {
2359
2324
  "tags": [
2360
- "Workorders",
2361
- "Tasks",
2362
- "Worklogs"
2325
+ "Foundation"
2363
2326
  ],
2364
2327
  "responses": {
2365
2328
  "200": {
2366
2329
  "content": {
2367
2330
  "application/json": {
2368
2331
  "schema": {
2369
- "$ref": "#/components/schemas/WorklogResponseSingle"
2332
+ "$ref": "#/components/schemas/OrganisationResponseList"
2370
2333
  }
2371
2334
  }
2372
2335
  },
2373
- "description": "Returns the created worklog"
2336
+ "description": "Returns all accessible Organisations"
2374
2337
  }
2375
2338
  },
2376
- "summary": "Add a worklog to a workorder task"
2339
+ "summary": "Get all Organisations"
2377
2340
  },
2378
2341
  "parameters": [
2379
2342
  {
2380
- "examples": {
2381
- "id": {
2382
- "value": "WO12345"
2383
- }
2384
- },
2385
- "name": "id",
2343
+ "name": "include",
2344
+ "description": "Defines if and which related objects shoudl be included.\nPossible values:\npersonRelations,persons",
2386
2345
  "schema": {
2387
2346
  "type": "string"
2388
2347
  },
2389
- "in": "path",
2390
- "required": true
2348
+ "in": "query"
2391
2349
  },
2392
2350
  {
2393
- "examples": {
2394
- "taskId": {
2395
- "value": "TAS1234"
2396
- }
2351
+ "name": "limit",
2352
+ "description": "limit the number of results returned",
2353
+ "schema": {
2354
+ "type": "integer"
2397
2355
  },
2398
- "name": "taskId",
2356
+ "in": "query",
2357
+ "required": false
2358
+ },
2359
+ {
2360
+ "name": "offset",
2361
+ "description": "offset used for pagination together with limit",
2399
2362
  "schema": {
2400
- "type": "string"
2363
+ "type": "integer"
2401
2364
  },
2402
- "in": "path",
2403
- "required": true
2365
+ "in": "query",
2366
+ "required": false
2404
2367
  }
2405
2368
  ]
2406
2369
  },
2407
- "/incidents/{id}/tasks/{taskId}/worklogs/{worklogId}": {
2370
+ "/supportgroups/": {
2408
2371
  "get": {
2409
2372
  "tags": [
2410
- "Tasks",
2411
- "Incidents",
2412
- "Worklogs"
2373
+ "Foundation"
2413
2374
  ],
2414
2375
  "responses": {
2415
2376
  "200": {
2416
2377
  "content": {
2417
2378
  "application/json": {
2418
2379
  "schema": {
2419
- "$ref": "#/components/schemas/WorklogResponseSingle"
2380
+ "$ref": "#/components/schemas/SupportGroupResponseList"
2420
2381
  }
2421
2382
  }
2422
2383
  },
2423
- "description": "Get a specific task worklog"
2384
+ "description": "Returns a list of all accessible Support Groups"
2424
2385
  }
2425
2386
  },
2426
- "summary": "Get a specific worklog of an incident task"
2387
+ "summary": "Get all support groups"
2427
2388
  },
2428
2389
  "parameters": [
2429
2390
  {
2430
- "examples": {
2431
- "id": {
2432
- "value": "INC12345"
2433
- }
2434
- },
2435
- "name": "id",
2391
+ "name": "include",
2392
+ "description": "Defines if and which related objects shoudl be included.\nPossible values:\npersonRelations,persons",
2436
2393
  "schema": {
2437
2394
  "type": "string"
2438
2395
  },
2439
- "in": "path",
2440
- "required": true
2396
+ "in": "query"
2441
2397
  },
2442
2398
  {
2443
- "examples": {
2444
- "taskId": {
2445
- "value": "TAS1234"
2446
- }
2447
- },
2448
- "name": "taskId",
2399
+ "name": "limit",
2400
+ "description": "limit the number of results returned",
2449
2401
  "schema": {
2450
- "type": "string"
2402
+ "type": "integer"
2451
2403
  },
2452
- "in": "path",
2453
- "required": true
2404
+ "in": "query",
2405
+ "required": false
2454
2406
  },
2455
2407
  {
2456
- "examples": {
2457
- "worklogId": {
2458
- "value": "WLG00391234"
2459
- }
2460
- },
2461
- "name": "worklogId",
2408
+ "name": "offset",
2409
+ "description": "offset used for pagination together with limit",
2462
2410
  "schema": {
2463
- "type": "string"
2411
+ "type": "integer"
2464
2412
  },
2465
- "in": "path",
2466
- "required": true
2413
+ "in": "query",
2414
+ "required": false
2467
2415
  }
2468
2416
  ]
2469
2417
  },
2470
- "/problems/{id}/tasks/{taskId}/worklogs/{worklogId}": {
2418
+ "/incidents": {
2419
+ "summary": "Create an Incident",
2471
2420
  "get": {
2472
2421
  "tags": [
2473
- "Tasks",
2474
- "Problems",
2475
- "Worklogs"
2422
+ "Incidents"
2423
+ ],
2424
+ "parameters": [
2425
+ {
2426
+ "name": "limit",
2427
+ "description": "limit the number of results returned",
2428
+ "schema": {
2429
+ "type": "integer"
2430
+ },
2431
+ "in": "query",
2432
+ "required": false
2433
+ },
2434
+ {
2435
+ "name": "offset",
2436
+ "description": "offset used for pagination together with limit",
2437
+ "schema": {
2438
+ "type": "integer"
2439
+ },
2440
+ "in": "query",
2441
+ "required": false
2442
+ }
2476
2443
  ],
2477
2444
  "responses": {
2478
2445
  "200": {
2479
2446
  "content": {
2480
2447
  "application/json": {
2481
2448
  "schema": {
2482
- "$ref": "#/components/schemas/WorklogResponseSingle"
2449
+ "$ref": "#/components/schemas/IncidentResponseList"
2483
2450
  }
2484
2451
  }
2485
- },
2486
- "description": "Get a specific task worklog"
2452
+ }
2487
2453
  }
2488
2454
  },
2489
- "summary": "Get a specific worklog of a problem task"
2455
+ "summary": "Get all Incidents"
2490
2456
  },
2491
- "parameters": [
2492
- {
2493
- "examples": {
2494
- "id": {
2495
- "value": "PBI12345"
2457
+ "post": {
2458
+ "requestBody": {
2459
+ "content": {
2460
+ "application/json": {
2461
+ "schema": {
2462
+ "$ref": "#/components/schemas/IncidentRequest"
2463
+ }
2496
2464
  }
2497
2465
  },
2498
- "name": "id",
2499
- "schema": {
2500
- "type": "string"
2501
- },
2502
- "in": "path",
2503
2466
  "required": true
2504
2467
  },
2505
- {
2506
- "examples": {
2507
- "taskId": {
2508
- "value": "TAS1234"
2468
+ "tags": [
2469
+ "Incidents"
2470
+ ],
2471
+ "responses": {
2472
+ "200": {
2473
+ "content": {
2474
+ "application/json": {
2475
+ "schema": {
2476
+ "$ref": "#/components/schemas/IncidentResponseSingle"
2477
+ }
2478
+ }
2509
2479
  }
2510
- },
2511
- "name": "taskId",
2512
- "schema": {
2513
- "type": "string"
2514
- },
2515
- "in": "path",
2516
- "required": true
2480
+ }
2517
2481
  },
2482
+ "summary": "Create a new Incident"
2483
+ },
2484
+ "parameters": [
2518
2485
  {
2519
2486
  "examples": {
2520
- "worklogId": {
2521
- "value": "WLG00391234"
2487
+ "include": {
2488
+ "value": "ciRelations,ticketRelations"
2522
2489
  }
2523
2490
  },
2524
- "name": "worklogId",
2491
+ "name": "include",
2492
+ "description": "Defines if and which related objects shoudl be included.\nPossible values:\nciRelations,ticketRelations,personRelations,organisationRelations,supportGroupRelations,persons,supportGroups,organisations,cmdbObjects,incidents,workOrders,changes, problems",
2525
2493
  "schema": {
2526
- "type": "string"
2494
+ "type": "array",
2495
+ "items": {
2496
+ "type": "string"
2497
+ }
2527
2498
  },
2528
- "in": "path",
2529
- "required": true
2499
+ "in": "query",
2500
+ "required": false
2530
2501
  }
2531
2502
  ]
2532
2503
  },
2533
- "/workorders/{id}/tasks/{taskId}/worklogs/{worklogId}": {
2504
+ "/problems": {
2534
2505
  "get": {
2535
2506
  "tags": [
2536
- "Tasks",
2537
- "Workorders",
2538
- "Worklogs"
2507
+ "Problems"
2508
+ ],
2509
+ "parameters": [
2510
+ {
2511
+ "name": "limit",
2512
+ "description": "limit the number of results returned",
2513
+ "schema": {
2514
+ "type": "integer"
2515
+ },
2516
+ "in": "query",
2517
+ "required": false
2518
+ },
2519
+ {
2520
+ "name": "offset",
2521
+ "description": "offset used for pagination together with limit",
2522
+ "schema": {
2523
+ "type": "integer"
2524
+ },
2525
+ "in": "query",
2526
+ "required": false
2527
+ }
2539
2528
  ],
2540
2529
  "responses": {
2541
2530
  "200": {
2542
2531
  "content": {
2543
2532
  "application/json": {
2544
2533
  "schema": {
2545
- "$ref": "#/components/schemas/WorklogResponseSingle"
2534
+ "$ref": "#/components/schemas/ProblemResponseList"
2546
2535
  }
2547
2536
  }
2548
- },
2549
- "description": "Get a specific task worklog"
2537
+ }
2550
2538
  }
2551
2539
  },
2552
- "summary": "Get a specific worklog of a workorder task"
2540
+ "summary": "Get all Problems",
2541
+ "description": "Get all problems that your user has access to."
2553
2542
  },
2554
- "parameters": [
2555
- {
2556
- "examples": {
2557
- "id": {
2558
- "value": "WO12345"
2543
+ "post": {
2544
+ "requestBody": {
2545
+ "content": {
2546
+ "application/json": {
2547
+ "schema": {
2548
+ "$ref": "#/components/schemas/WorkorderRequest"
2549
+ }
2559
2550
  }
2560
2551
  },
2561
- "name": "id",
2562
- "schema": {
2563
- "type": "string"
2564
- },
2565
- "in": "path",
2566
2552
  "required": true
2567
2553
  },
2554
+ "tags": [
2555
+ "Problems"
2556
+ ],
2557
+ "responses": {
2558
+ "200": {
2559
+ "content": {
2560
+ "application/json": {
2561
+ "schema": {
2562
+ "$ref": "#/components/schemas/ProblemResponseSingle"
2563
+ }
2564
+ }
2565
+ }
2566
+ }
2567
+ },
2568
+ "summary": "Create a new Problem"
2569
+ },
2570
+ "parameters": [
2568
2571
  {
2569
2572
  "examples": {
2570
- "taskId": {
2571
- "value": "TAS1234"
2573
+ "include": {
2574
+ "value": "ciRelations,ticketRelations"
2572
2575
  }
2573
2576
  },
2574
- "name": "taskId",
2577
+ "name": "include",
2578
+ "description": "Defines if and which related objects shoudl be included.\nPossible values:\nciRelations,ticketRelations,personRelations,organisationRelations,supportGroupRelations,persons,supportGroups,organisations,cmdbObjects,incidents,workOrders,changes, problems",
2575
2579
  "schema": {
2576
- "type": "string"
2580
+ "type": "array",
2581
+ "items": {
2582
+ "type": "string"
2583
+ }
2584
+ },
2585
+ "in": "query",
2586
+ "required": false
2587
+ }
2588
+ ]
2589
+ },
2590
+ "/workorders": {
2591
+ "get": {
2592
+ "tags": [
2593
+ "Workorders"
2594
+ ],
2595
+ "parameters": [
2596
+ {
2597
+ "name": "limit",
2598
+ "description": "limit the number of results returned",
2599
+ "schema": {
2600
+ "type": "integer"
2601
+ },
2602
+ "in": "query",
2603
+ "required": false
2604
+ },
2605
+ {
2606
+ "name": "offset",
2607
+ "description": "offset used for pagination together with limit",
2608
+ "schema": {
2609
+ "type": "integer"
2610
+ },
2611
+ "in": "query",
2612
+ "required": false
2613
+ }
2614
+ ],
2615
+ "responses": {
2616
+ "200": {
2617
+ "content": {
2618
+ "application/json": {
2619
+ "schema": {
2620
+ "$ref": "#/components/schemas/WorkorderResponseList"
2621
+ }
2622
+ }
2623
+ }
2624
+ }
2625
+ },
2626
+ "summary": "Get all workorders"
2627
+ },
2628
+ "post": {
2629
+ "requestBody": {
2630
+ "content": {
2631
+ "application/json": {
2632
+ "schema": {
2633
+ "$ref": "#/components/schemas/WorkorderRequest"
2634
+ }
2635
+ }
2577
2636
  },
2578
- "in": "path",
2579
2637
  "required": true
2580
2638
  },
2639
+ "tags": [
2640
+ "Workorders"
2641
+ ],
2642
+ "responses": {
2643
+ "200": {
2644
+ "content": {
2645
+ "application/json": {
2646
+ "schema": {
2647
+ "$ref": "#/components/schemas/WorkorderResponseSingle"
2648
+ }
2649
+ }
2650
+ }
2651
+ }
2652
+ },
2653
+ "summary": "Create a new Workorder"
2654
+ },
2655
+ "parameters": [
2581
2656
  {
2582
2657
  "examples": {
2583
- "worklogId": {
2584
- "value": "WLG00391234"
2658
+ "include": {
2659
+ "value": "ciRelations,ticketRelations"
2585
2660
  }
2586
2661
  },
2587
- "name": "worklogId",
2662
+ "name": "include",
2663
+ "description": "Defines if and which related objects shoudl be included.\nPossible values: \nciRelations,ticketRelations,personRelations,organisationRelations,supportGroupRelations,persons,supportGroups,organisations,cmdbObjects,incidents,workOrders,changes, problems",
2588
2664
  "schema": {
2589
- "type": "string"
2665
+ "type": "array",
2666
+ "items": {
2667
+ "type": "string"
2668
+ }
2590
2669
  },
2591
- "in": "path",
2592
- "required": true
2670
+ "in": "query",
2671
+ "required": false
2593
2672
  }
2594
2673
  ]
2595
2674
  },
2596
- "/appconfig/forms": {
2675
+ "/changes": {
2597
2676
  "get": {
2598
2677
  "tags": [
2599
- "AppConfig"
2678
+ "Changes"
2679
+ ],
2680
+ "parameters": [
2681
+ {
2682
+ "name": "limit",
2683
+ "description": "limit the number of results returned",
2684
+ "schema": {
2685
+ "type": "integer"
2686
+ },
2687
+ "in": "query",
2688
+ "required": false
2689
+ },
2690
+ {
2691
+ "name": "offset",
2692
+ "description": "offset used for pagination together with limit",
2693
+ "schema": {
2694
+ "type": "integer"
2695
+ },
2696
+ "in": "query",
2697
+ "required": false
2698
+ }
2600
2699
  ],
2601
2700
  "responses": {
2602
2701
  "200": {
2603
2702
  "content": {
2604
2703
  "application/json": {
2605
2704
  "schema": {
2606
- "type": "array",
2607
- "items": {
2608
- "type": "string"
2609
- }
2705
+ "$ref": "#/components/schemas/ChangeResponseList"
2610
2706
  }
2611
2707
  }
2612
- },
2613
- "description": "Return all forms"
2708
+ }
2614
2709
  }
2615
- }
2616
- }
2617
- },
2618
- "/appconfig/forms/{id}/fields": {
2619
-
2620
- },
2621
- "/templates/{templateType}": {
2622
- "get": {
2710
+ },
2711
+ "summary": "Get all Changes"
2712
+ },
2713
+ "post": {
2714
+ "requestBody": {
2715
+ "content": {
2716
+ "application/json": {
2717
+ "schema": {
2718
+ "$ref": "#/components/schemas/ChangeRequest"
2719
+ }
2720
+ }
2721
+ },
2722
+ "required": true
2723
+ },
2623
2724
  "tags": [
2624
- "Templates",
2625
- "Changes",
2626
- "Incidents",
2627
- "Problems",
2628
- "Tasks",
2629
- "Workorders"
2725
+ "Changes"
2630
2726
  ],
2631
2727
  "responses": {
2632
2728
  "200": {
2633
- "$ref": "#/components/responses/TemplateResponseArray"
2729
+ "content": {
2730
+ "application/json": {
2731
+ "schema": {
2732
+ "$ref": "#/components/schemas/ChangeResponseList"
2733
+ }
2734
+ }
2735
+ }
2634
2736
  }
2635
2737
  },
2636
- "summary": "Get all templates of a specific type"
2738
+ "summary": "Create a new Change"
2637
2739
  },
2638
2740
  "parameters": [
2639
2741
  {
2640
2742
  "examples": {
2641
- "templatetyp": {
2642
- "value": "incidents"
2743
+ "include": {
2744
+ "value": "ciRelations,ticketRelations"
2643
2745
  }
2644
2746
  },
2645
- "name": "templateType",
2646
- "description": "The template type. Possible values:\n\nincidents\nproblems\nchanges\nworkorders\ntasks",
2747
+ "name": "include",
2748
+ "description": "Defines if and which related objects shoudl be included.\nPossible values:\nciRelations,ticketRelations,personRelations,organisationRelations,supportGroupRelations,persons,supportGroups,organisations,cmdbObjects,incidents,workOrders,changes, problems",
2647
2749
  "schema": {
2648
- "type": "string"
2750
+ "type": "array",
2751
+ "items": {
2752
+ "type": "string"
2753
+ }
2754
+ },
2755
+ "in": "query",
2756
+ "required": false
2757
+ }
2758
+ ]
2759
+ },
2760
+ "/incidents/{id}/worklogs/{worklogId}/attachments/1": {
2761
+ "get": {
2762
+ "tags": [
2763
+ "Incidents",
2764
+ "Worklogs"
2765
+ ],
2766
+ "responses": {
2767
+ "200": {
2768
+ "$ref": "#/components/responses/attachmentResponse"
2769
+ }
2770
+ },
2771
+ "summary": "Get an Incident Worklog Attachment"
2772
+ },
2773
+ "post": {
2774
+ "requestBody": {
2775
+ "description": "Send the data in the key: \"file\"",
2776
+ "content": {
2777
+ "application/x-www-form-urlencoded": {
2778
+
2779
+ }
2649
2780
  },
2650
- "in": "path",
2651
2781
  "required": true
2652
2782
  },
2783
+ "tags": [
2784
+ "Incidents",
2785
+ "Worklogs"
2786
+ ],
2787
+ "responses": {
2788
+ "200": {
2789
+ "description": "Attachment added"
2790
+ }
2791
+ },
2792
+ "summary": "Set an Incident Worklog Attachment"
2793
+ },
2794
+ "parameters": [
2653
2795
  {
2654
- "name": "limit",
2655
- "description": "limit the number of results returned",
2796
+ "name": "worklogId",
2656
2797
  "schema": {
2657
- "type": "integer"
2798
+ "type": "string"
2658
2799
  },
2659
- "in": "query",
2660
- "required": false
2800
+ "in": "path",
2801
+ "required": true
2661
2802
  },
2662
2803
  {
2663
- "name": "offset",
2664
- "description": "offset used for pagination together with limit",
2804
+ "name": "id",
2665
2805
  "schema": {
2666
- "type": "integer"
2806
+ "type": "string"
2667
2807
  },
2668
- "in": "query",
2669
- "required": false
2808
+ "in": "path",
2809
+ "required": true
2670
2810
  }
2671
2811
  ]
2672
2812
  },
2673
- "/templates/{templateType}/{id}": {
2813
+ "/incidents/{id}/worklogs/{worklogId}/attachments/2": {
2674
2814
  "get": {
2675
2815
  "tags": [
2676
- "Templates",
2677
- "Changes",
2678
2816
  "Incidents",
2679
- "Problems",
2680
- "Tasks",
2681
- "Workorders"
2817
+ "Worklogs"
2818
+ ],
2819
+ "responses": {
2820
+ "200": {
2821
+ "$ref": "#/components/responses/attachmentResponse"
2822
+ }
2823
+ },
2824
+ "summary": "Get an Incident Worklog Attachment"
2825
+ },
2826
+ "post": {
2827
+ "requestBody": {
2828
+ "description": "Send the data in the key: \"file\"",
2829
+ "content": {
2830
+ "application/x-www-form-urlencoded": {
2831
+
2832
+ }
2833
+ },
2834
+ "required": true
2835
+ },
2836
+ "tags": [
2837
+ "Incidents",
2838
+ "Worklogs"
2682
2839
  ],
2683
2840
  "responses": {
2684
2841
  "200": {
2685
- "$ref": "#/components/responses/TemplateResponseSingle"
2842
+ "description": "Attachment added"
2686
2843
  }
2687
2844
  },
2688
- "summary": "Get a specific template"
2845
+ "summary": "Set an Incident Worklog Attachment"
2689
2846
  },
2690
2847
  "parameters": [
2691
2848
  {
2692
- "examples": {
2693
- "templatetyp": {
2694
- "value": "incidents"
2695
- }
2696
- },
2697
- "name": "templateType",
2698
- "description": "The template type. Possible values:\n\nincidents\nproblems\nchanges\nworkorders\ntasks",
2849
+ "name": "worklogId",
2699
2850
  "schema": {
2700
2851
  "type": "string"
2701
2852
  },
@@ -2703,13 +2854,7 @@
2703
2854
  "required": true
2704
2855
  },
2705
2856
  {
2706
- "examples": {
2707
- "templatetyp": {
2708
- "value": "AG029ed9200194dcnlas991"
2709
- }
2710
- },
2711
2857
  "name": "id",
2712
- "description": "The id of the template",
2713
2858
  "schema": {
2714
2859
  "type": "string"
2715
2860
  },
@@ -2718,545 +2863,479 @@
2718
2863
  }
2719
2864
  ]
2720
2865
  },
2721
- "/persons": {
2866
+ "/incidents/{id}/worklogs/{worklogId}/attachments/3": {
2722
2867
  "get": {
2723
2868
  "tags": [
2724
- "Foundation"
2869
+ "Incidents",
2870
+ "Worklogs"
2725
2871
  ],
2726
2872
  "responses": {
2727
2873
  "200": {
2728
- "content": {
2729
- "application/json": {
2730
- "schema": {
2731
- "$ref": "#/components/schemas/PersonResponseList"
2732
- }
2733
- }
2734
- },
2735
- "description": "Return an array of persons that are accessible with the defined basequery.\n\nNote: supportGroups are only included in single person requests."
2874
+ "$ref": "#/components/responses/attachmentResponse"
2736
2875
  }
2737
2876
  },
2738
- "summary": "Get all persons"
2877
+ "summary": "Get an Incident Worklog Attachment"
2739
2878
  },
2740
- "parameters": [
2741
- {
2742
- "examples": {
2743
- "include": {
2744
- "value": "groupMembership"
2745
- }
2746
- },
2747
- "name": "include",
2748
- "description": "Defines if and which related objects shoudl be included.\nPossible values: groupMembership",
2749
- "schema": {
2750
- "type": "array",
2751
- "items": {
2752
- "type": "string"
2879
+ "post": {
2880
+ "requestBody": {
2881
+ "description": "Send the data in the key: \"file\"",
2882
+ "content": {
2883
+ "application/x-www-form-urlencoded": {
2884
+
2753
2885
  }
2754
2886
  },
2755
- "in": "query",
2756
- "required": false
2887
+ "required": true
2888
+ },
2889
+ "tags": [
2890
+ "Incidents",
2891
+ "Worklogs"
2892
+ ],
2893
+ "responses": {
2894
+ "200": {
2895
+ "description": "Attachment added"
2896
+ }
2757
2897
  },
2898
+ "summary": "Set an Incident Worklog Attachment"
2899
+ },
2900
+ "parameters": [
2758
2901
  {
2759
- "name": "limit",
2760
- "description": "limit the number of results returned",
2902
+ "name": "worklogId",
2761
2903
  "schema": {
2762
- "type": "integer"
2904
+ "type": "string"
2763
2905
  },
2764
- "in": "query",
2765
- "required": false
2906
+ "in": "path",
2907
+ "required": true
2766
2908
  },
2767
2909
  {
2768
- "name": "offset",
2769
- "description": "offset used for pagination together with limit",
2910
+ "name": "id",
2770
2911
  "schema": {
2771
- "type": "integer"
2912
+ "type": "string"
2772
2913
  },
2773
- "in": "query",
2774
- "required": false
2914
+ "in": "path",
2915
+ "required": true
2775
2916
  }
2776
2917
  ]
2777
2918
  },
2778
- "/organisations/": {
2919
+ "/appconfig/clients": {
2779
2920
  "get": {
2780
2921
  "tags": [
2781
- "Foundation"
2922
+ "AppConfig"
2782
2923
  ],
2783
2924
  "responses": {
2784
2925
  "200": {
2785
2926
  "content": {
2786
2927
  "application/json": {
2787
2928
  "schema": {
2788
- "$ref": "#/components/schemas/OrganisationResponseList"
2929
+ "$ref": "#/components/schemas/AppConfigClientResponseList"
2789
2930
  }
2790
2931
  }
2791
- },
2792
- "description": "Returns all accessible Organisations"
2932
+ }
2793
2933
  }
2794
2934
  },
2795
- "summary": "Get all Organisations"
2935
+ "summary": "Get all clients"
2796
2936
  },
2797
- "parameters": [
2798
- {
2799
- "name": "include",
2800
- "description": "Defines if and which related objects shoudl be included.\nPossible values:\npersonRelations,persons",
2801
- "schema": {
2802
- "type": "string"
2803
- },
2804
- "in": "query"
2805
- },
2806
- {
2807
- "name": "limit",
2808
- "description": "limit the number of results returned",
2809
- "schema": {
2810
- "type": "integer"
2811
- },
2812
- "in": "query",
2813
- "required": false
2937
+ "post": {
2938
+ "tags": [
2939
+ "AppConfig"
2940
+ ],
2941
+ "responses": {
2942
+ "200": {
2943
+ "description": "Client added"
2944
+ }
2814
2945
  },
2815
- {
2816
- "name": "offset",
2817
- "description": "offset used for pagination together with limit",
2818
- "schema": {
2819
- "type": "integer"
2820
- },
2821
- "in": "query",
2822
- "required": false
2823
- }
2824
- ]
2946
+ "summary": "Create a new Client"
2947
+ }
2825
2948
  },
2826
- "/supportgroups/": {
2949
+ "/scripts": {
2827
2950
  "get": {
2828
2951
  "tags": [
2829
- "Foundation"
2952
+ "Scripts"
2830
2953
  ],
2831
2954
  "responses": {
2832
2955
  "200": {
2833
2956
  "content": {
2834
2957
  "application/json": {
2835
2958
  "schema": {
2836
- "$ref": "#/components/schemas/SupportGroupResponseList"
2959
+ "type": "array",
2960
+ "items": {
2961
+ "$ref": "#/components/schemas/script"
2962
+ }
2837
2963
  }
2838
2964
  }
2839
2965
  },
2840
- "description": "Returns a list of all accessible Support Groups"
2966
+ "description": "Returns an array with all scripts"
2841
2967
  }
2842
2968
  },
2843
- "summary": "Get all support groups"
2969
+ "summary": "Get all scripts"
2844
2970
  },
2845
- "parameters": [
2846
- {
2847
- "name": "include",
2848
- "description": "Defines if and which related objects shoudl be included.\nPossible values:\npersonRelations,persons",
2849
- "schema": {
2850
- "type": "string"
2971
+ "post": {
2972
+ "requestBody": {
2973
+ "content": {
2974
+ "application/json": {
2975
+ "schema": {
2976
+ "$ref": "#/components/schemas/script"
2977
+ }
2978
+ }
2851
2979
  },
2852
- "in": "query"
2980
+ "required": true
2853
2981
  },
2854
- {
2855
- "name": "limit",
2856
- "description": "limit the number of results returned",
2857
- "schema": {
2858
- "type": "integer"
2859
- },
2860
- "in": "query",
2861
- "required": false
2982
+ "tags": [
2983
+ "Scripts"
2984
+ ],
2985
+ "responses": {
2986
+ "200": {
2987
+ "$ref": "#/components/responses/ScriptDefinitionResponse"
2988
+ }
2862
2989
  },
2863
- {
2864
- "name": "offset",
2865
- "description": "offset used for pagination together with limit",
2866
- "schema": {
2867
- "type": "integer"
2868
- },
2869
- "in": "query",
2870
- "required": false
2871
- }
2872
- ]
2990
+ "summary": "Create a new script",
2991
+ "description": "Create a new script that is accessible by all catalog items."
2992
+ }
2873
2993
  },
2874
- "/incidents": {
2875
- "summary": "Create an Incident",
2994
+ "/scripts/{scriptId}": {
2876
2995
  "get": {
2877
2996
  "tags": [
2878
- "Incidents"
2879
- ],
2880
- "parameters": [
2881
- {
2882
- "name": "limit",
2883
- "description": "limit the number of results returned",
2884
- "schema": {
2885
- "type": "integer"
2886
- },
2887
- "in": "query",
2888
- "required": false
2889
- },
2890
- {
2891
- "name": "offset",
2892
- "description": "offset used for pagination together with limit",
2893
- "schema": {
2894
- "type": "integer"
2895
- },
2896
- "in": "query",
2897
- "required": false
2898
- }
2997
+ "Scripts"
2899
2998
  ],
2900
2999
  "responses": {
2901
3000
  "200": {
2902
3001
  "content": {
2903
3002
  "application/json": {
2904
3003
  "schema": {
2905
- "$ref": "#/components/schemas/IncidentResponseList"
3004
+ "$ref": "#/components/schemas/script"
2906
3005
  }
2907
3006
  }
2908
- }
3007
+ },
3008
+ "description": "Return a script"
2909
3009
  }
2910
3010
  },
2911
- "summary": "Get all Incidents"
3011
+ "summary": "Get a global script"
2912
3012
  },
2913
- "post": {
3013
+ "put": {
2914
3014
  "requestBody": {
2915
3015
  "content": {
2916
3016
  "application/json": {
2917
3017
  "schema": {
2918
- "$ref": "#/components/schemas/IncidentRequest"
3018
+ "$ref": "#/components/schemas/script"
2919
3019
  }
2920
3020
  }
2921
3021
  },
2922
3022
  "required": true
2923
3023
  },
2924
3024
  "tags": [
2925
- "Incidents"
3025
+ "Scripts"
2926
3026
  ],
2927
3027
  "responses": {
2928
3028
  "200": {
2929
- "content": {
2930
- "application/json": {
2931
- "schema": {
2932
- "$ref": "#/components/schemas/IncidentResponseSingle"
2933
- }
2934
- }
2935
- }
3029
+ "$ref": "#/components/responses/ScriptDefinitionResponse"
3030
+ }
3031
+ },
3032
+ "summary": "Update a script",
3033
+ "description": "Updates a existing script that is accessible by all catalog item."
3034
+ },
3035
+ "delete": {
3036
+ "tags": [
3037
+ "Scripts"
3038
+ ],
3039
+ "responses": {
3040
+ "200": {
3041
+ "$ref": "#/components/responses/DeleteResponse"
2936
3042
  }
2937
3043
  },
2938
- "summary": "Create a new Incident"
3044
+ "summary": "Delete this script"
2939
3045
  },
2940
3046
  "parameters": [
2941
3047
  {
2942
3048
  "examples": {
2943
- "include": {
2944
- "value": "ciRelations,ticketRelations"
3049
+ "catalogIdExample": {
3050
+ "value": "serverRestart"
2945
3051
  }
2946
3052
  },
2947
- "name": "include",
2948
- "description": "Defines if and which related objects shoudl be included.\nPossible values:\nciRelations,ticketRelations,personRelations,organisationRelations,supportGroupRelations,persons,supportGroups,organisations,cmdbObjects,incidents,workOrders,changes, problems",
3053
+ "name": "scriptId",
2949
3054
  "schema": {
2950
- "type": "array",
2951
- "items": {
2952
- "type": "string"
2953
- }
3055
+ "type": "string"
2954
3056
  },
2955
- "in": "query",
2956
- "required": false
3057
+ "in": "path",
3058
+ "required": true
2957
3059
  }
2958
3060
  ]
2959
3061
  },
2960
- "/problems": {
3062
+ "/incidents/{id}/tasks/{taskId}": {
2961
3063
  "get": {
2962
3064
  "tags": [
2963
- "Problems"
2964
- ],
2965
- "parameters": [
2966
- {
2967
- "name": "limit",
2968
- "description": "limit the number of results returned",
2969
- "schema": {
2970
- "type": "integer"
2971
- },
2972
- "in": "query",
2973
- "required": false
2974
- },
2975
- {
2976
- "name": "offset",
2977
- "description": "offset used for pagination together with limit",
2978
- "schema": {
2979
- "type": "integer"
2980
- },
2981
- "in": "query",
2982
- "required": false
2983
- }
3065
+ "Incidents",
3066
+ "Tasks"
2984
3067
  ],
2985
3068
  "responses": {
2986
3069
  "200": {
2987
3070
  "content": {
2988
3071
  "application/json": {
2989
3072
  "schema": {
2990
- "$ref": "#/components/schemas/ProblemResponseList"
3073
+ "$ref": "#/components/schemas/TaskResponseList"
2991
3074
  }
2992
3075
  }
2993
- }
3076
+ },
3077
+ "description": "Get a specific task of an Incident"
2994
3078
  }
2995
3079
  },
2996
- "summary": "Get all Problems",
2997
- "description": "Get all problems that your user has access to."
3080
+ "summary": "Get a specific task of a Inciden"
2998
3081
  },
2999
- "post": {
3082
+ "put": {
3000
3083
  "requestBody": {
3001
3084
  "content": {
3002
3085
  "application/json": {
3003
3086
  "schema": {
3004
- "$ref": "#/components/schemas/WorkorderRequest"
3087
+ "$ref": "#/components/schemas/TaskRequest"
3005
3088
  }
3006
3089
  }
3007
3090
  },
3008
3091
  "required": true
3009
3092
  },
3010
3093
  "tags": [
3011
- "Problems"
3094
+ "Incidents",
3095
+ "Tasks"
3012
3096
  ],
3013
3097
  "responses": {
3014
3098
  "200": {
3015
3099
  "content": {
3016
3100
  "application/json": {
3017
3101
  "schema": {
3018
- "$ref": "#/components/schemas/ProblemResponseSingle"
3102
+ "$ref": "#/components/schemas/TaskResponseSingle"
3019
3103
  }
3020
3104
  }
3021
- }
3105
+ },
3106
+ "description": "Return the updated task"
3022
3107
  }
3023
3108
  },
3024
- "summary": "Create a new Problem"
3109
+ "summary": "Update a task"
3025
3110
  },
3026
3111
  "parameters": [
3027
3112
  {
3028
3113
  "examples": {
3029
- "include": {
3030
- "value": "ciRelations,ticketRelations"
3114
+ "id": {
3115
+ "value": "INC12345"
3031
3116
  }
3032
3117
  },
3033
- "name": "include",
3034
- "description": "Defines if and which related objects shoudl be included.\nPossible values:\nciRelations,ticketRelations,personRelations,organisationRelations,supportGroupRelations,persons,supportGroups,organisations,cmdbObjects,incidents,workOrders,changes, problems",
3118
+ "name": "id",
3035
3119
  "schema": {
3036
- "type": "array",
3037
- "items": {
3038
- "type": "string"
3120
+ "type": "string"
3121
+ },
3122
+ "in": "path",
3123
+ "required": true
3124
+ },
3125
+ {
3126
+ "examples": {
3127
+ "taskId": {
3128
+ "value": "TAS1234"
3039
3129
  }
3040
3130
  },
3041
- "in": "query",
3042
- "required": false
3131
+ "name": "taskId",
3132
+ "schema": {
3133
+ "type": "string"
3134
+ },
3135
+ "in": "path",
3136
+ "required": true
3043
3137
  }
3044
3138
  ]
3045
3139
  },
3046
- "/workorders": {
3140
+ "/changes/{id}/tasks": {
3047
3141
  "get": {
3048
3142
  "tags": [
3049
- "Workorders"
3050
- ],
3051
- "parameters": [
3052
- {
3053
- "name": "limit",
3054
- "description": "limit the number of results returned",
3055
- "schema": {
3056
- "type": "integer"
3057
- },
3058
- "in": "query",
3059
- "required": false
3060
- },
3061
- {
3062
- "name": "offset",
3063
- "description": "offset used for pagination together with limit",
3064
- "schema": {
3065
- "type": "integer"
3066
- },
3067
- "in": "query",
3068
- "required": false
3069
- }
3143
+ "Changes",
3144
+ "Tasks"
3070
3145
  ],
3071
3146
  "responses": {
3072
3147
  "200": {
3073
3148
  "content": {
3074
3149
  "application/json": {
3075
3150
  "schema": {
3076
- "$ref": "#/components/schemas/WorkorderResponseList"
3151
+ "$ref": "#/components/schemas/TaskResponseList"
3077
3152
  }
3078
3153
  }
3079
- }
3154
+ },
3155
+ "description": "Get all tasks of a change"
3080
3156
  }
3081
3157
  },
3082
- "summary": "Get all workorders"
3158
+ "summary": "Get all tasks of a change"
3083
3159
  },
3084
3160
  "post": {
3085
3161
  "requestBody": {
3086
3162
  "content": {
3087
3163
  "application/json": {
3088
3164
  "schema": {
3089
- "$ref": "#/components/schemas/WorkorderRequest"
3165
+ "$ref": "#/components/schemas/TaskRequest"
3090
3166
  }
3091
3167
  }
3092
3168
  },
3093
3169
  "required": true
3094
3170
  },
3095
3171
  "tags": [
3096
- "Workorders"
3172
+ "Changes",
3173
+ "Tasks"
3097
3174
  ],
3098
3175
  "responses": {
3099
3176
  "200": {
3100
3177
  "content": {
3101
3178
  "application/json": {
3102
3179
  "schema": {
3103
- "$ref": "#/components/schemas/WorkorderResponseSingle"
3180
+ "$ref": "#/components/schemas/TaskResponseSingle"
3104
3181
  }
3105
3182
  }
3106
- }
3183
+ },
3184
+ "description": "Return the new change task"
3107
3185
  }
3108
3186
  },
3109
- "summary": "Create a new Workorder"
3187
+ "summary": "Add a task to a change"
3110
3188
  },
3111
3189
  "parameters": [
3112
3190
  {
3113
3191
  "examples": {
3114
- "include": {
3115
- "value": "ciRelations,ticketRelations"
3192
+ "id": {
3193
+ "value": "CRQ12345"
3116
3194
  }
3117
3195
  },
3118
- "name": "include",
3119
- "description": "Defines if and which related objects shoudl be included.\nPossible values: \nciRelations,ticketRelations,personRelations,organisationRelations,supportGroupRelations,persons,supportGroups,organisations,cmdbObjects,incidents,workOrders,changes, problems",
3196
+ "name": "id",
3120
3197
  "schema": {
3121
- "type": "array",
3122
- "items": {
3123
- "type": "string"
3124
- }
3198
+ "type": "string"
3125
3199
  },
3126
- "in": "query",
3127
- "required": false
3200
+ "in": "path",
3201
+ "required": true
3128
3202
  }
3129
3203
  ]
3130
3204
  },
3131
- "/changes": {
3205
+ "/changes/{id}/tasks/{taskId}": {
3132
3206
  "get": {
3133
3207
  "tags": [
3134
- "Changes"
3135
- ],
3136
- "parameters": [
3137
- {
3138
- "name": "limit",
3139
- "description": "limit the number of results returned",
3140
- "schema": {
3141
- "type": "integer"
3142
- },
3143
- "in": "query",
3144
- "required": false
3145
- },
3146
- {
3147
- "name": "offset",
3148
- "description": "offset used for pagination together with limit",
3149
- "schema": {
3150
- "type": "integer"
3151
- },
3152
- "in": "query",
3153
- "required": false
3154
- }
3208
+ "Changes",
3209
+ "Tasks"
3155
3210
  ],
3156
3211
  "responses": {
3157
3212
  "200": {
3158
3213
  "content": {
3159
3214
  "application/json": {
3160
3215
  "schema": {
3161
- "$ref": "#/components/schemas/ChangeResponseList"
3216
+ "$ref": "#/components/schemas/TaskResponseList"
3162
3217
  }
3163
3218
  }
3164
- }
3219
+ },
3220
+ "description": "Get a specific task of a change"
3165
3221
  }
3166
3222
  },
3167
- "summary": "Get all Changes"
3223
+ "summary": "Get a specific task of a change"
3168
3224
  },
3169
- "post": {
3225
+ "put": {
3170
3226
  "requestBody": {
3171
3227
  "content": {
3172
3228
  "application/json": {
3173
3229
  "schema": {
3174
- "$ref": "#/components/schemas/ChangeRequest"
3230
+ "$ref": "#/components/schemas/TaskRequest"
3175
3231
  }
3176
3232
  }
3177
3233
  },
3178
3234
  "required": true
3179
3235
  },
3180
3236
  "tags": [
3181
- "Changes"
3237
+ "Changes",
3238
+ "Tasks"
3182
3239
  ],
3183
3240
  "responses": {
3184
3241
  "200": {
3185
3242
  "content": {
3186
3243
  "application/json": {
3187
3244
  "schema": {
3188
- "$ref": "#/components/schemas/ChangeResponseList"
3245
+ "$ref": "#/components/schemas/TaskResponseSingle"
3189
3246
  }
3190
3247
  }
3191
- }
3248
+ },
3249
+ "description": "Return the updated task"
3192
3250
  }
3193
3251
  },
3194
- "summary": "Create a new Change"
3252
+ "summary": "Update a task"
3195
3253
  },
3196
3254
  "parameters": [
3197
3255
  {
3198
3256
  "examples": {
3199
- "include": {
3200
- "value": "ciRelations,ticketRelations"
3257
+ "id": {
3258
+ "value": "CRQ12345"
3201
3259
  }
3202
3260
  },
3203
- "name": "include",
3204
- "description": "Defines if and which related objects shoudl be included.\nPossible values:\nciRelations,ticketRelations,personRelations,organisationRelations,supportGroupRelations,persons,supportGroups,organisations,cmdbObjects,incidents,workOrders,changes, problems",
3261
+ "name": "id",
3205
3262
  "schema": {
3206
- "type": "array",
3207
- "items": {
3208
- "type": "string"
3263
+ "type": "string"
3264
+ },
3265
+ "in": "path",
3266
+ "required": true
3267
+ },
3268
+ {
3269
+ "examples": {
3270
+ "taskId": {
3271
+ "value": "TAS1234"
3209
3272
  }
3210
3273
  },
3211
- "in": "query",
3212
- "required": false
3274
+ "name": "taskId",
3275
+ "schema": {
3276
+ "type": "string"
3277
+ },
3278
+ "in": "path",
3279
+ "required": true
3213
3280
  }
3214
3281
  ]
3215
3282
  },
3216
- "/incidents/{id}/worklogs/{worklogId}/attachments/1": {
3283
+ "/problems/{id}/tasks": {
3217
3284
  "get": {
3218
3285
  "tags": [
3219
- "Incidents",
3220
- "Worklogs"
3286
+ "Problems",
3287
+ "Tasks"
3221
3288
  ],
3222
3289
  "responses": {
3223
3290
  "200": {
3224
- "$ref": "#/components/responses/attachmentResponse"
3291
+ "content": {
3292
+ "application/json": {
3293
+ "schema": {
3294
+ "$ref": "#/components/schemas/TaskResponseList"
3295
+ }
3296
+ }
3297
+ },
3298
+ "description": "Get all tasks of a problem"
3225
3299
  }
3226
3300
  },
3227
- "summary": "Get an Incident Worklog Attachment"
3301
+ "summary": "Get all tasks of a problem"
3228
3302
  },
3229
3303
  "post": {
3230
3304
  "requestBody": {
3231
- "description": "Send the data in the key: \"file\"",
3232
3305
  "content": {
3233
- "application/x-www-form-urlencoded": {
3234
-
3306
+ "application/json": {
3307
+ "schema": {
3308
+ "$ref": "#/components/schemas/TaskRequest"
3309
+ }
3235
3310
  }
3236
3311
  },
3237
3312
  "required": true
3238
3313
  },
3239
3314
  "tags": [
3240
- "Incidents",
3241
- "Worklogs"
3315
+ "Problems",
3316
+ "Tasks"
3242
3317
  ],
3243
3318
  "responses": {
3244
3319
  "200": {
3245
- "description": "Attachment added"
3320
+ "content": {
3321
+ "application/json": {
3322
+ "schema": {
3323
+ "$ref": "#/components/schemas/TaskResponseSingle"
3324
+ }
3325
+ }
3326
+ },
3327
+ "description": "Return the new problem task"
3246
3328
  }
3247
3329
  },
3248
- "summary": "Set an Incident Worklog Attachment"
3330
+ "summary": "Add a task to a problem"
3249
3331
  },
3250
3332
  "parameters": [
3251
3333
  {
3252
- "name": "worklogId",
3253
- "schema": {
3254
- "type": "string"
3334
+ "examples": {
3335
+ "id": {
3336
+ "value": "PBI12345"
3337
+ }
3255
3338
  },
3256
- "in": "path",
3257
- "required": true
3258
- },
3259
- {
3260
3339
  "name": "id",
3261
3340
  "schema": {
3262
3341
  "type": "string"
@@ -3266,43 +3345,63 @@
3266
3345
  }
3267
3346
  ]
3268
3347
  },
3269
- "/incidents/{id}/worklogs/{worklogId}/attachments/2": {
3348
+ "/problems/{id}/tasks/{taskId}": {
3270
3349
  "get": {
3271
3350
  "tags": [
3272
- "Incidents",
3273
- "Worklogs"
3351
+ "Problems",
3352
+ "Tasks"
3274
3353
  ],
3275
3354
  "responses": {
3276
3355
  "200": {
3277
- "$ref": "#/components/responses/attachmentResponse"
3356
+ "content": {
3357
+ "application/json": {
3358
+ "schema": {
3359
+ "$ref": "#/components/schemas/TaskResponseList"
3360
+ }
3361
+ }
3362
+ },
3363
+ "description": "Get a specific task of a problem"
3278
3364
  }
3279
3365
  },
3280
- "summary": "Get an Incident Worklog Attachment"
3366
+ "summary": "Get a specific task of a problem"
3281
3367
  },
3282
- "post": {
3368
+ "put": {
3283
3369
  "requestBody": {
3284
- "description": "Send the data in the key: \"file\"",
3285
3370
  "content": {
3286
- "application/x-www-form-urlencoded": {
3287
-
3371
+ "application/json": {
3372
+ "schema": {
3373
+ "$ref": "#/components/schemas/TaskRequest"
3374
+ }
3288
3375
  }
3289
3376
  },
3290
3377
  "required": true
3291
3378
  },
3292
3379
  "tags": [
3293
- "Incidents",
3294
- "Worklogs"
3380
+ "Problems",
3381
+ "Tasks"
3295
3382
  ],
3296
3383
  "responses": {
3297
3384
  "200": {
3298
- "description": "Attachment added"
3385
+ "content": {
3386
+ "application/json": {
3387
+ "schema": {
3388
+ "$ref": "#/components/schemas/TaskResponseSingle"
3389
+ }
3390
+ }
3391
+ },
3392
+ "description": "Return the updated problem task"
3299
3393
  }
3300
3394
  },
3301
- "summary": "Set an Incident Worklog Attachment"
3395
+ "summary": "Update a problem task"
3302
3396
  },
3303
3397
  "parameters": [
3304
3398
  {
3305
- "name": "worklogId",
3399
+ "examples": {
3400
+ "id": {
3401
+ "value": "PBI12345"
3402
+ }
3403
+ },
3404
+ "name": "id",
3306
3405
  "schema": {
3307
3406
  "type": "string"
3308
3407
  },
@@ -3310,7 +3409,12 @@
3310
3409
  "required": true
3311
3410
  },
3312
3411
  {
3313
- "name": "id",
3412
+ "examples": {
3413
+ "taskId": {
3414
+ "value": "TAS1234"
3415
+ }
3416
+ },
3417
+ "name": "taskId",
3314
3418
  "schema": {
3315
3419
  "type": "string"
3316
3420
  },
@@ -3319,50 +3423,62 @@
3319
3423
  }
3320
3424
  ]
3321
3425
  },
3322
- "/incidents/{id}/worklogs/{worklogId}/attachments/3": {
3426
+ "/workorders/{id}/tasks": {
3323
3427
  "get": {
3324
3428
  "tags": [
3325
- "Incidents",
3326
- "Worklogs"
3429
+ "Workorders",
3430
+ "Tasks"
3327
3431
  ],
3328
3432
  "responses": {
3329
3433
  "200": {
3330
- "$ref": "#/components/responses/attachmentResponse"
3434
+ "content": {
3435
+ "application/json": {
3436
+ "schema": {
3437
+ "$ref": "#/components/schemas/TaskResponseList"
3438
+ }
3439
+ }
3440
+ },
3441
+ "description": "Get all tasks of a work order"
3331
3442
  }
3332
3443
  },
3333
- "summary": "Get an Incident Worklog Attachment"
3444
+ "summary": "Get all tasks of a work order"
3334
3445
  },
3335
3446
  "post": {
3336
3447
  "requestBody": {
3337
- "description": "Send the data in the key: \"file\"",
3338
3448
  "content": {
3339
- "application/x-www-form-urlencoded": {
3340
-
3449
+ "application/json": {
3450
+ "schema": {
3451
+ "$ref": "#/components/schemas/TaskRequest"
3452
+ }
3341
3453
  }
3342
3454
  },
3343
3455
  "required": true
3344
3456
  },
3345
3457
  "tags": [
3346
- "Incidents",
3347
- "Worklogs"
3458
+ "Workorders",
3459
+ "Tasks"
3348
3460
  ],
3349
3461
  "responses": {
3350
3462
  "200": {
3351
- "description": "Attachment added"
3463
+ "content": {
3464
+ "application/json": {
3465
+ "schema": {
3466
+ "$ref": "#/components/schemas/TaskResponseSingle"
3467
+ }
3468
+ }
3469
+ },
3470
+ "description": "Return the new work order task"
3352
3471
  }
3353
3472
  },
3354
- "summary": "Set an Incident Worklog Attachment"
3473
+ "summary": "Add a task to a work order"
3355
3474
  },
3356
3475
  "parameters": [
3357
3476
  {
3358
- "name": "worklogId",
3359
- "schema": {
3360
- "type": "string"
3477
+ "examples": {
3478
+ "id": {
3479
+ "value": "WO12345"
3480
+ }
3361
3481
  },
3362
- "in": "path",
3363
- "required": true
3364
- },
3365
- {
3366
3482
  "name": "id",
3367
3483
  "schema": {
3368
3484
  "type": "string"
@@ -3372,141 +3488,141 @@
3372
3488
  }
3373
3489
  ]
3374
3490
  },
3375
- "/appconfig/clients": {
3491
+ "/workorders/{id}/tasks/{taskId}": {
3376
3492
  "get": {
3377
3493
  "tags": [
3378
- "AppConfig"
3494
+ "Workorders",
3495
+ "Tasks"
3379
3496
  ],
3380
3497
  "responses": {
3381
3498
  "200": {
3382
3499
  "content": {
3383
3500
  "application/json": {
3384
3501
  "schema": {
3385
- "$ref": "#/components/schemas/AppConfigClientResponseList"
3502
+ "$ref": "#/components/schemas/TaskResponseList"
3386
3503
  }
3387
3504
  }
3388
- }
3505
+ },
3506
+ "description": "Get a specific task of a Workorder"
3389
3507
  }
3390
3508
  },
3391
- "summary": "Get all clients"
3509
+ "summary": "Get a specific task of a Workorder"
3392
3510
  },
3393
- "post": {
3394
- "tags": [
3395
- "AppConfig"
3396
- ],
3397
- "responses": {
3398
- "200": {
3399
- "description": "Client added"
3400
- }
3511
+ "put": {
3512
+ "requestBody": {
3513
+ "content": {
3514
+ "application/json": {
3515
+ "schema": {
3516
+ "$ref": "#/components/schemas/TaskRequest"
3517
+ }
3518
+ }
3519
+ },
3520
+ "required": true
3401
3521
  },
3402
- "summary": "Create a new Client"
3403
- }
3404
- },
3405
- "/scripts": {
3406
- "get": {
3407
3522
  "tags": [
3408
- "Scripts"
3523
+ "Workorders",
3524
+ "Tasks"
3409
3525
  ],
3410
3526
  "responses": {
3411
3527
  "200": {
3412
3528
  "content": {
3413
3529
  "application/json": {
3414
3530
  "schema": {
3415
- "type": "array",
3416
- "items": {
3417
- "$ref": "#/components/schemas/script"
3418
- }
3531
+ "$ref": "#/components/schemas/TaskResponseSingle"
3419
3532
  }
3420
3533
  }
3421
3534
  },
3422
- "description": "Returns an array with all scripts"
3535
+ "description": "Return the updated task"
3423
3536
  }
3424
3537
  },
3425
- "summary": "Get all scripts"
3538
+ "summary": "Update a task"
3426
3539
  },
3427
- "post": {
3428
- "requestBody": {
3429
- "content": {
3430
- "application/json": {
3431
- "schema": {
3432
- "$ref": "#/components/schemas/script"
3433
- }
3540
+ "parameters": [
3541
+ {
3542
+ "examples": {
3543
+ "id": {
3544
+ "value": "WO12345"
3434
3545
  }
3435
3546
  },
3547
+ "name": "id",
3548
+ "schema": {
3549
+ "type": "string"
3550
+ },
3551
+ "in": "path",
3436
3552
  "required": true
3437
3553
  },
3438
- "tags": [
3439
- "Scripts"
3440
- ],
3441
- "responses": {
3442
- "200": {
3443
- "$ref": "#/components/responses/ScriptDefinitionResponse"
3444
- }
3445
- },
3446
- "summary": "Create a new script",
3447
- "description": "Create a new script that is accessible by all catalog items."
3448
- }
3554
+ {
3555
+ "examples": {
3556
+ "taskId": {
3557
+ "value": "TAS1234"
3558
+ }
3559
+ },
3560
+ "name": "taskId",
3561
+ "schema": {
3562
+ "type": "string"
3563
+ },
3564
+ "in": "path",
3565
+ "required": true
3566
+ }
3567
+ ]
3449
3568
  },
3450
- "/scripts/{scriptId}": {
3569
+ "/incidents/{id}/tasks": {
3451
3570
  "get": {
3452
3571
  "tags": [
3453
- "Scripts"
3572
+ "Incidents",
3573
+ "Tasks"
3454
3574
  ],
3455
3575
  "responses": {
3456
3576
  "200": {
3457
3577
  "content": {
3458
3578
  "application/json": {
3459
3579
  "schema": {
3460
- "$ref": "#/components/schemas/script"
3580
+ "$ref": "#/components/schemas/TaskResponseList"
3461
3581
  }
3462
3582
  }
3463
3583
  },
3464
- "description": "Return a script"
3584
+ "description": "Get all tasks of an incident"
3465
3585
  }
3466
3586
  },
3467
- "summary": "Get a global script"
3587
+ "summary": "Get all tasks of an incident"
3468
3588
  },
3469
- "put": {
3589
+ "post": {
3470
3590
  "requestBody": {
3471
3591
  "content": {
3472
3592
  "application/json": {
3473
3593
  "schema": {
3474
- "$ref": "#/components/schemas/script"
3594
+ "$ref": "#/components/schemas/TaskRequest"
3475
3595
  }
3476
3596
  }
3477
3597
  },
3478
3598
  "required": true
3479
3599
  },
3480
3600
  "tags": [
3481
- "Scripts"
3482
- ],
3483
- "responses": {
3484
- "200": {
3485
- "$ref": "#/components/responses/ScriptDefinitionResponse"
3486
- }
3487
- },
3488
- "summary": "Update a script",
3489
- "description": "Updates a existing script that is accessible by all catalog item."
3490
- },
3491
- "delete": {
3492
- "tags": [
3493
- "Scripts"
3601
+ "Incidents",
3602
+ "Tasks"
3494
3603
  ],
3495
3604
  "responses": {
3496
3605
  "200": {
3497
- "$ref": "#/components/responses/DeleteResponse"
3606
+ "content": {
3607
+ "application/json": {
3608
+ "schema": {
3609
+ "$ref": "#/components/schemas/TaskResponseSingle"
3610
+ }
3611
+ }
3612
+ },
3613
+ "description": "Return the new incident task"
3498
3614
  }
3499
3615
  },
3500
- "summary": "Delete this script"
3616
+ "summary": "Add a task to an incident"
3501
3617
  },
3502
3618
  "parameters": [
3503
3619
  {
3504
3620
  "examples": {
3505
- "catalogIdExample": {
3506
- "value": "serverRestart"
3621
+ "id": {
3622
+ "value": "INC12345"
3507
3623
  }
3508
3624
  },
3509
- "name": "scriptId",
3625
+ "name": "id",
3510
3626
  "schema": {
3511
3627
  "type": "string"
3512
3628
  },