BridgeGatewayCatalogTest/RESTService.ProcessTrace.yaml at master · e2ebridge/BridgeGatewayCatalogTest · 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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
basePath: /rest/trace/api
consumes:
- application/json
- text/xml
definitions:
  Event:
    properties:
      event:
        type: string
  Choice:
    properties:
      gateway:
        type: string
      choice:
        type: string
  Value:
    properties:
      key:
        type: string
      stringValue:
        type: string
      floatValue:
        type: string
      dateTimeValue:
        type: string
  ProcessTraceError:
    properties:
      message:
        type: string
info:
  description: Interface to E2E Process Trace
  title: ProcessTrace
  version: 1.0.0
paths:
  /process/{processName}/{processId}/start:
    post:
      description: trace the start of a new process instance
      parameters:
      - description: the name of the process
        in: path
        name: processName
        required: true
        type: string
      - description: the id of the process instance
        in: path
        name: processId
        required: true
        type: string
      - description: a structure defining the name of the start event
        in: body
        name: startEvent
        required: true
        schema:
          $ref: '#/definitions/Event'
      responses:
        '204':
          description: ''
        default:
          description: this is the default return message in case of errors
          schema:
            $ref: '#/definitions/ProcessTraceError'
      summary: trace the start of a new process instance
      tags:
      - Process Flow
  /process/{processName}/{processId}/state/{stateName}/start:
    post:
      description: trace a state entry of a process instance
      parameters:
      - description: the name of the process
        in: path
        name: processName
        required: true
        type: string
      - description: the id of the process instance
        in: path
        name: processId
        required: true
        type: string
      - description: the name of the state
        in: path
        name: stateName
        required: true
        type: string
      responses:
        '204':
          description: ''
        default:
          description: this is the default return message in case of errors
          schema:
            $ref: '#/definitions/ProcessTraceError'
      summary: trace a state entry of a process instance
      tags:
      - Process Flow
  /process/{processName}/{processId}/state/{stateName}/end:
    post:
      description: trace a state exit of a process instance
      parameters:
      - description: the name of the process
        in: path
        name: processName
        required: true
        type: string
      - description: the id of the process instance
        in: path
        name: processId
        required: true
        type: string
      - description: the name of the state
        in: path
        name: stateName
        required: true
        type: string
      responses:
        '204':
          description: ''
        default:
          description: this is the default return message in case of errors
          schema:
            $ref: '#/definitions/ProcessTraceError'
      summary: trace a state exit of a process instance
      tags:
      - Process Flow
  /process/{processName}/{processId}/end:
    post:
      description: trace the end of a process instance
      parameters:
      - description: the name of the process
        in: path
        name: processName
        required: true
        type: string
      - description: the id of the process instance
        in: path
        name: processId
        required: true
        type: string
      - description: a structure defining the name of the end event
        in: body
        name: endEvent
        required: true
        schema:
          $ref: '#/definitions/Event'
      responses:
        '204':
          description: ''
        default:
          description: this is the default return message in case of errors
          schema:
            $ref: '#/definitions/ProcessTraceError'
      summary: trace the end of a process instance
      tags:
      - Process Flow
  /process/{processName}/{processId}/choice:
    post:
      description: trace a decision point in process instance's flow
      parameters:
      - description: the name of the process
        in: path
        name: processName
        required: true
        type: string
      - description: the id of the process instance
        in: path
        name: processId
        required: true
        type: string
      - description: a structure defining the choice
        in: body
        name: choice
        required: true
        schema:
          $ref: '#/definitions/Choice'
      responses:
        '204':
          description: ''
        default:
          description: this is the default return message in case of errors
          schema:
            $ref: '#/definitions/ProcessTraceError'
      summary: trace a decision point in process instance's flow
      tags:
      - Process Flow
  /process/{processName}/{processId}/value:
    post:
      description: trace additional information for a process instance
      parameters:
      - description: the name of the process
        in: path
        name: processName
        required: true
        type: string
      - description: the id of the process instance
        in: path
        name: processId
        required: true
        type: string
      - description: a structure defining the value to trace (only one of stringValue, floatValue, dateTimeValue must be non-null)
        in: body
        name: value
        required: true
        schema:
          $ref: '#/definitions/Value'
      responses:
        '204':
          description: ''
        default:
          description: this is the default return message in case of errors
          schema:
            $ref: '#/definitions/ProcessTraceError'
      summary: trace additional information for a process instance
      tags:
      - Custom Values
  /process/{processName}/{processId}/event:
    post:
      description: trace an incoming event on a process instance
      parameters:
      - description: the name of the process
        in: path
        name: processName
        required: true
        type: string
      - description: the id of the process instance
        in: path
        name: processId
        required: true
        type: string
      - description: a structure defining the name of the event
        in: body
        name: event
        required: true
        schema:
          $ref: '#/definitions/Event'
      responses:
        '204':
          description: ''
        default:
          description: this is the default return message in case of errors
          schema:
            $ref: '#/definitions/ProcessTraceError'
      summary: trace an incoming event on a process instance
      tags:
      - Process Flow
produces:
- application/json
- text/xml
swagger: '2.0'
tags:
- description: ''
  name: Custom Values
- description: ''
  name: Process Flow