K2-Workflow-API/K2_RESTAPI_modified.json at master · BradleyFestraets/K2-Workflow-API · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
{
  "swagger": "2.0",
  "info": {
    "version": "preview",
    "title": "K2 Workflow Api"
  },
  "host": "nzcloud.onk2.com",
  "basePath": "/Api/Workflow/Preview",
  "schemes": [
    "https"
  ],
  "paths": {
    "/workflows/{id}": {
      "post": {
        "tags": [
          "Workflows"
        ],
        "summary": "Start Workflow",
        "description": "Creates and starts a new workflow instance.",
        "operationId": "StartWorkflow",
        "consumes": [
          "application/json",
          "text/json",
          "application/x-www-form-urlencoded"
        ],
        "produces": [
          "application/json",
          "text/json"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Select a workflow",
            "required": true,
            "type": "integer",
            "format": "int32"
          },
          {
            "name": "PostRequestBody",
            "in": "body",
            "schema": {
              "type": "object"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Creates and starts a new workflow instance.",
            "schema": {
              "format": "int32",
              "type": "integer"
            }
          },
          "400": {
            "description": "Returns information about the error that occurred.",
            "schema": {
              "type": "object",
              "additionalProperties": {
                "type": "object"
              }
            }
          },
          "404": {
            "description": "Returns information about the error that occurred.",
            "schema": {
              "type": "object",
              "additionalProperties": {
                "type": "object"
              }
            }
          },
          "default": {
            "description": "Creates and starts a new workflow instance.",
            "schema": {
              "format": "int32",
              "type": "integer"
            }
          }
        }
      }
    },
    "/serverEvents/{serialNumber}/finish": {
      "post": {
        "tags": [
          "ServerEvents"
        ],
        "summary": "Finish Server Event",
        "description": "Send a finish response to an async server task awaiting a response",
        "operationId": "FinishServerEvent",
        "consumes": [
          "application/json",
          "text/json",
          "application/x-www-form-urlencoded"
        ],
        "produces": [],
        "parameters": [
          {
            "name": "serialNumber",
            "in": "path",
            "required": true,
            "type": "string"
          },
          {
            "name": "PostRequestBody",
            "in": "body",
            "schema": {
              "type": "object"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "Send a finish response to an async server task awaiting a response",
            "schema": {
              "type": "object"
            }
          },
          "400": {
            "description": "Returns information about the error that occurred.",
            "schema": {
              "type": "object"
            }
          },
          "404": {
            "description": "Returns information about the error that occurred.",
            "schema": {
              "type": "object"
            }
          },
          "default": {
            "description": "Send a finish response to an async server task awaiting a response",
            "schema": {
              "type": "object"
            }
          }
        }
      }
    }
  },
  "definitions": {},
  "securityDefinitions": {
    "basic": {
      "type": "basic",
      "description": "Basic HTTP Authentication"
    },
    "oauth2": {
      "type": "oauth2",
      "description": "Appit AAD",
      "flow": "implicit",
      "authorizationUrl": "https://login.windows.net/dia.govt.nz/oauth2/authorize",
      "scopes": {}
    }
  },
  "security": [
    {
      "basic": []
    },
    {
      "oauth2": []
    }
  ]
}