mod-audit/ramls/acquisition-events.raml at master · folio-org/mod-audit · 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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
#%RAML 1.0

title: Acquisition Audit events API
baseUri: https://github.com/folio-org/mod-audit
version: v1

documentation:
  - title: Acquisition Audit events API
    content: API for retrieving events for acquisition changes

types:
  errors: !include raml-util/schemas/errors.schema
  order-line-audit-event: !include order_line_audit_event.json
  order-audit-event: !include order_audit_event.json
  order-audit-event-collection: !include order_audit_event_collection.json
  order-line-audit-event-collection: !include order_line_audit_event_collection.json
  piece-audit-event: !include piece_audit_event.json
  piece-audit-event-collection: !include piece_audit_event_collection.json
  invoice-audit-event: !include invoice_audit_event.json
  invoice-audit-event-collection: !include invoice_audit_event_collection.json
  invoice-line-audit-event-collection: !include invoice_line_audit_event_collection.json
  organization-audit-event: !include organization_audit_event.json
  organization-audit-event-collection: !include organization_audit_event_collection.json

traits:
  searchable: !include raml-util/traits/searchable.raml
  pageable: !include raml-util/traits/pageable.raml
  validate: !include raml-util/traits/validation.raml

/audit-data/acquisition:
  /order/{id}:
    get:
      description: Get list of order events by order_id
      is: [
        pageable,
        validate
      ]
      queryParameters:
        sortBy:
          description: "sorting by field: actionDate"
          type: string
          default: action_date
        sortOrder:
          description: "sort order: asc or desc"
          enum: [asc, desc]
          type: string
          default: desc
        limit:
          default: 2147483647
        offset:
          default: 0
      responses:
        200:
          body:
            application/json:
              type: order-audit-event-collection
        500:
          description: "Internal server error"
          body:
            application/json:
              type: errors
              example:
                strict: false
                value: !include raml-util/examples/errors.sample

  /order-line/{id}:
    get:
      description: Get list of order_line events by order_line_id
      is: [
          pageable,
          validate
      ]
      queryParameters:
        sortBy:
          description: "sorting by field: actionDate"
          type: string
          default: action_date
        sortOrder:
          description: "sort order: asc or desc"
          enum: [asc, desc]
          type: string
          default: desc
        limit:
          default: 2147483647
        offset:
          default: 0
      responses:
        200:
          body:
            application/json:
              type: order-line-audit-event-collection
        500:
          description: "Internal server error"
          body:
            application/json:
              type: errors

  /piece/{id}:
    get:
      description: Get list of piece events by piece_id
      is: [
        pageable,
        validate
      ]
      queryParameters:
        sortBy:
          description: "sorting by field: actionDate"
          type: string
          default: action_date
        sortOrder:
          description: "sort order: asc or desc"
          enum: [asc, desc]
          type: string
          default: desc
        limit:
          default: 2147483647
        offset:
          default: 0
      responses:
        200:
          body:
            application/json:
              type: piece-audit-event-collection
        500:
          description: "Internal server error"
          body:
            application/json:
              type: errors
              example:
                strict: false
                value: !include raml-util/examples/errors.sample
  /piece/{id}/status-change-history:
    get:
      description: Get list of piece events which have unique status changes by piece_id
      is: [
        pageable,
        validate
      ]
      queryParameters:
        sortBy:
          description: "sorting by field: actionDate"
          type: string
          default: action_date
        sortOrder:
          description: "sort order: asc or desc"
          enum: [asc, desc]
          type: string
          default: desc
        limit:
          default: 2147483647
        offset:
          default: 0
      responses:
        200:
          body:
            application/json:
              type: piece-audit-event-collection
        500:
          description: "Internal server error"
          body:
            application/json:
              type: errors
              example:
                strict: false
                value: !include raml-util/examples/errors.sample

  /invoice/{id}:
    get:
      description: Get list of invoice events by invoice_id
      is: [
        pageable,
        validate
      ]
      queryParameters:
        sortBy:
          description: "sorting by field: actionDate"
          type: string
          default: action_date
        sortOrder:
          description: "sort order: asc or desc"
          enum: [asc, desc]
          type: string
          default: desc
        limit:
          default: 2147483647
        offset:
          default: 0
      responses:
        200:
          body:
            application/json:
              type: invoice-audit-event-collection
        500:
          description: "Internal server error"
          body:
            application/json:
              type: errors
              example:
                strict: false
                value: !include raml-util/examples/errors.sample

  /invoice-line/{id}:
    get:
      description: Get list of invoice_line events by invoice_line_id
      is: [
          pageable,
          validate
      ]
      queryParameters:
        sortBy:
          description: "sorting by field: actionDate"
          type: string
          default: action_date
        sortOrder:
          description: "sort order: asc or desc"
          enum: [asc, desc]
          type: string
          default: desc
        limit:
          default: 2147483647
        offset:
          default: 0
      responses:
        200:
          body:
            application/json:
              type: invoice-line-audit-event-collection
        500:
          description: "Internal server error"
          body:
            application/json:
              type: errors

  /organization/{id}:
    get:
      description: Get list of organization events by organization_id
      is: [
        pageable,
        validate
      ]
      queryParameters:
        sortBy:
          description: "sorting by field: actionDate"
          type: string
          default: action_date
        sortOrder:
          description: "sort order: asc or desc"
          enum: [asc, desc]
          type: string
          default: desc
        limit:
          default: 2147483647
        offset:
          default: 0
      responses:
        200:
          body:
            application/json:
              type: organization-audit-event-collection
        500:
          description: "Internal server error"
          body:
            application/json:
              type: errors
              example:
                strict: false
                value: !include raml-util/examples/errors.sample