Skip to content

Commit 7993952

Browse files
author
cibot
committed
Definitions Update cargo
1 parent 68d75ad commit 7993952

File tree

1 file changed

+389
-0
lines changed

1 file changed

+389
-0
lines changed

‎alsdkdefs/apis/cargo/cargo.v2.yaml‎

Lines changed: 389 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,389 @@
1+
openapi: 3.0.2
2+
info:
3+
title: Cargo
4+
version: '2.0'
5+
description: "Report Scheduling and Delivery service designed to manage customer schedule definitions, execute reports and provide access to report artifacts."
6+
servers:
7+
- url: 'https://api.cloudinsight.alertlogic.com'
8+
description: US production
9+
x-alertlogic-session-endpoint: true
10+
- url: 'https://api.cloudinsight.alertlogic.co.uk'
11+
description: UK production
12+
x-alertlogic-session-endpoint: true
13+
- url: 'https://api.product.dev.alertlogic.com'
14+
description: integration
15+
x-alertlogic-session-endpoint: true
16+
paths:
17+
'/cargo/v2/{account_id}/schedule':
18+
parameters:
19+
- $ref: '#/components/parameters/AccountId'
20+
get:
21+
summary: List Schedules
22+
tags: [Schedules]
23+
responses:
24+
'200':
25+
description: OK
26+
content:
27+
application/json:
28+
schema:
29+
type: object
30+
properties:
31+
schedules:
32+
type: array
33+
items:
34+
$ref: '#/components/schemas/Schedule'
35+
examples:
36+
List Schedules Response Example:
37+
value:
38+
schedules:
39+
- name: 'Report Name'
40+
account_id: '67000001'
41+
id: '17C13BFD-3953-1005-BD8A-0EB9B569AE5D'
42+
type: 'search'
43+
schedule:
44+
daily:
45+
hour: 15
46+
minute: 5
47+
latest_schedule: 1819108200
48+
is_active: true
49+
notify_behavior: 'always'
50+
delete_empty_result: true
51+
definition:
52+
key: 'value'
53+
created:
54+
at: 1469023199
55+
by: null
56+
modified:
57+
at: 1469023400
58+
by: null
59+
operationId: list_schedules
60+
description: |-
61+
Get list of schedules for given `account_id`. If `type` parameter is not specfied, returns all schedules for account
62+
security:
63+
- X-AIMS-Auth-Token: []
64+
parameters:
65+
- name: type
66+
schema:
67+
$ref: '#/components/schemas/Schedule-Type'
68+
in: query
69+
'/cargo/v2/{account_id}/execution_record':
70+
parameters:
71+
- $ref: '#/components/parameters/AccountId'
72+
get:
73+
summary: List Execution Records
74+
tags: [Execution Records]
75+
responses:
76+
'200':
77+
description: OK
78+
content:
79+
application/json:
80+
schema:
81+
type: object
82+
properties:
83+
execution_records:
84+
type: array
85+
items:
86+
$ref: '#/components/schemas/Execution-Record'
87+
continuation:
88+
type: string
89+
examples:
90+
List Execution Records Response Example:
91+
value:
92+
execution_records:
93+
- name: 'Report Name'
94+
account_id: '67000001'
95+
id: '20210428-120100-3A37D887-AB7F-1005-8001-0242AC11001F'
96+
schedule_id: '3A37D887-AB7F-1005-8001-0242AC11001F'
97+
type: 'tableau'
98+
status: 'completed'
99+
scheduled_time: 1619611260
100+
schedule:
101+
daily:
102+
hour: 15
103+
minute: 5
104+
run_once: false
105+
retry: 0
106+
published: false
107+
publish_result: null
108+
notify_behavior: 'ifnotempty'
109+
delete_empty_result: false
110+
artifact_data:
111+
result_id: '3535505E-C11B-1005-8001-0242AC11000C'
112+
result_count: 0
113+
metadata:
114+
key: 'value'
115+
is_reference: false
116+
format: 'pdf'
117+
create_time: 1619611265
118+
attachments: []
119+
definition:
120+
key: 'value'
121+
created:
122+
at: 1619611260
123+
by: null
124+
modified:
125+
at: 1619611260
126+
by: null
127+
operationId: list_execution_records
128+
description: |-
129+
List execution records for given `account_id`
130+
parameters:
131+
- name: schedule_id
132+
schema:
133+
type: string
134+
in: query
135+
- name: latest_only
136+
schema:
137+
type: boolean
138+
default: false
139+
in: query
140+
- name: status
141+
schema:
142+
$ref: '#/components/schemas/Execution-Record-Status'
143+
in: query
144+
- name: start_time
145+
schema:
146+
type: number
147+
in: query
148+
- name: end_time
149+
schema:
150+
type: number
151+
in: query
152+
- name: continuation
153+
schema:
154+
type: string
155+
in: query
156+
- name: order
157+
schema:
158+
type: string
159+
enum:
160+
- asc
161+
- desc
162+
default: desc
163+
in: query
164+
- name: type
165+
schema:
166+
$ref: '#/components/schemas/Schedule-Type'
167+
in: query
168+
- name: limit
169+
schema:
170+
type: integer
171+
minimum: 1
172+
maximum: 1000
173+
default: 100
174+
in: query
175+
security:
176+
- X-AIMS-Auth-Token: []
177+
'/cargo/v2/{account_id}/execution_record/{exec_id}/rerun':
178+
parameters:
179+
- $ref: '#/components/parameters/AccountId'
180+
post:
181+
summary: Re-run Execution Record
182+
tags: [Execution Records]
183+
responses:
184+
'201':
185+
description: OK
186+
operationId: rerun_execution_record
187+
description: |-
188+
Re-run execution record for given `account_id` and `exec_id`
189+
security:
190+
- X-AIMS-Auth-Token: []
191+
parameters:
192+
- name: exec_id
193+
schema:
194+
type: string
195+
in: path
196+
required: true
197+
'/cargo/v2/{account_id}/execution_record/rerun':
198+
parameters:
199+
- $ref: '#/components/parameters/AccountId'
200+
post:
201+
summary: Re-run Execution Records in batch
202+
tags: [Execution Records]
203+
responses:
204+
'201':
205+
description: OK
206+
operationId: rerun_execution_records
207+
description: |-
208+
Re-run multiple execution records for given `account_id` and `exec_id`s
209+
security:
210+
- X-AIMS-Auth-Token: []
211+
parameters:
212+
- name: ids
213+
schema:
214+
type: string
215+
in: query
216+
required: true
217+
components:
218+
parameters:
219+
AccountId:
220+
name: account_id
221+
schema:
222+
type: string
223+
in: path
224+
required: true
225+
description: AIMS Account Id
226+
schemas:
227+
Schedule:
228+
type: object
229+
properties:
230+
id:
231+
type: string
232+
account_id:
233+
type: string
234+
name:
235+
type: string
236+
schedule:
237+
$ref: '#/components/schemas/Schedule-Spec'
238+
type:
239+
$ref: '#/components/schemas/Schedule-Type'
240+
definition:
241+
type: object
242+
created:
243+
type: object
244+
properties:
245+
at:
246+
type: number
247+
by:
248+
type: string
249+
modified:
250+
type: object
251+
properties:
252+
at:
253+
type: number
254+
by:
255+
type: string
256+
latest_schedule:
257+
type: number
258+
is_active:
259+
type: boolean
260+
notify_behavior:
261+
$ref: '#/components/schemas/Notify-Behavior'
262+
delete_empty_result:
263+
type: boolean
264+
Execution-Record:
265+
type: object
266+
properties:
267+
account_id:
268+
type: string
269+
id:
270+
type: string
271+
schedule_id:
272+
type: string
273+
name:
274+
type: string
275+
status:
276+
$ref: '#/components/schemas/Execution-Record-Status'
277+
type:
278+
$ref: '#/components/schemas/Schedule-Type'
279+
definition:
280+
type: object
281+
artifact_data:
282+
type: object
283+
created:
284+
type: object
285+
properties:
286+
at:
287+
type: integer
288+
by:
289+
type: string
290+
modified:
291+
type: object
292+
properties:
293+
at:
294+
type: integer
295+
by:
296+
type: string
297+
schedule:
298+
$ref: '#/components/schemas/Schedule-Spec'
299+
scheduled_time:
300+
type: integer
301+
notify_behavior:
302+
$ref: '#/components/schemas/Notify-Behavior'
303+
delete_empty_result:
304+
type: boolean
305+
run_once:
306+
type: boolean
307+
published:
308+
type: boolean
309+
publish_result:
310+
type: object
311+
nullable: true
312+
retry:
313+
type: integer
314+
Notify-Behavior:
315+
type: string
316+
enum:
317+
- always
318+
- never
319+
- ifnotempty
320+
Schedule-Type:
321+
type: string
322+
enum:
323+
- tableau
324+
- search
325+
- search_v2
326+
Execution-Record-Status:
327+
type: string
328+
enum:
329+
- scheduled
330+
- running
331+
- cancelled
332+
- failed
333+
- completed
334+
Schedule-Spec:
335+
oneOf:
336+
- type: string
337+
enum:
338+
- every_15_minutes
339+
- type: object
340+
properties:
341+
hourly:
342+
type: object
343+
properties:
344+
minute:
345+
type: integer
346+
daily:
347+
type: object
348+
properties:
349+
hour:
350+
type: integer
351+
minute:
352+
type: integer
353+
weekly:
354+
type: object
355+
properties:
356+
day:
357+
type: string
358+
enum:
359+
- monday
360+
- tuesday
361+
- wednesday
362+
- thursday
363+
- friday
364+
- saturday
365+
- sunday
366+
hour:
367+
type: integer
368+
minute:
369+
type: integer
370+
monthly:
371+
type: object
372+
properties:
373+
day:
374+
type: integer
375+
hour:
376+
type: integer
377+
minute:
378+
type: integer
379+
securitySchemes:
380+
X-AIMS-Auth-Token:
381+
name: X-AIMS-Auth-Token
382+
type: apiKey
383+
in: header
384+
description: AIMS Authentication Token
385+
tags:
386+
- name: Schedules
387+
description: Schedules
388+
- name: Execution Records
389+
description: Execution Records

0 commit comments

Comments
 (0)