vivenu jobs API
The jobs API from vivenu — 5 operation(s) for jobs.
OpenAPI Specification
openapi: 3.0.3
info:
title: vivenu access-lists jobs API
description: vivenu API Documentation
version: 1.0.0
contact:
name: vivenu GmbH
url: https://vivenu.com
servers:
- url: https://vivenu.com
description: Production API
- url: https://vivenu.dev
description: Staging API
tags:
- name: jobs
paths:
/api/jobs:
get:
security:
- jwt: []
- apikey: []
parameters:
- name: skip
required: false
schema:
type: number
format: float
description: The number of objects to skip for the requested result
metas: {}
in: query
style: form
explode: true
- name: top
required: false
schema:
type: number
format: float
description: A limit on the number of objects to be returned. Can range between 1 and 1000.
default: 25
metas: {}
in: query
style: form
explode: true
- name: type
required: false
schema:
type: string
enum:
- import
- export
- delete
- scheduledJob
- transformJob
description: The type of an job to filter for
metas: {}
in: query
style: form
explode: true
- name: status
required: false
schema:
type: string
enum:
- SCHEDULED
- RUNNING
- FAILED
- COMPLETED
- COMPLETED_WITH_ERRORS
description: The status of an job to filter for
metas: {}
in: query
style: form
explode: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GET_Jobs_GetAllJobs_200_response'
'400':
description: Bad Request
'401':
description: Unauthorized
tags:
- jobs
description: Get all jobs
operationId: get_all_jobs
post:
security:
- jwt: []
- apikey: []
parameters: []
responses:
'202':
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/POST_Jobs_CreateAnJob_202_response'
'400':
description: Bad Request
'401':
description: Unauthorized
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/POST_Jobs_CreateAnJob'
tags:
- jobs
description: Create an job
operationId: create_an_job
/api/jobs/schedules:
get:
security:
- jwt: []
- apikey: []
parameters:
- name: task
required: false
schema:
oneOf:
- type: object
properties:
type:
type: string
enum:
- dashboard
dashboardId:
type: string
metas: {}
required:
- type
- type: object
properties:
type:
type: string
enum:
- report
description: The filter by task type.
metas: {}
required:
- type
metas: {}
in: query
style: deepObject
explode: true
- name: top
required: false
schema:
type: integer
maximum: 1000
description: A limit on the number of objects to be returned. Can range between 1 and 1000.
default: 25
metas: {}
in: query
style: form
explode: true
- name: skip
required: false
schema:
type: integer
description: The number of objects to skip for the requested result
metas: {}
in: query
style: form
explode: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GET_Jobs_GetAllScheduledJobs_200_response'
'400':
description: Bad Request
'401':
description: Unauthorized
tags:
- jobs
description: Get All Scheduled Jobs
operationId: jobs/getAllScheduledJobs
post:
security:
- jwt: []
- apikey: []
parameters: []
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/POST_Jobs_CreateAScheduledJob_201_response'
'400':
description: Bad Request
'401':
description: Unauthorized
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/POST_Jobs_CreateAScheduledJob'
tags:
- jobs
description: Create a Scheduled Job
operationId: jobs/createScheduledJob
/api/jobs/{id}:
get:
security:
- jwt: []
- apikey: []
parameters:
- name: id
required: true
schema:
type: string
metas: {}
in: path
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GET_Jobs_GetAnJob_200_response'
'400':
description: Bad Request
'401':
description: Unauthorized
tags:
- jobs
description: Get an job
operationId: get_an_job
/api/jobs/schedules/{id}:
get:
security:
- jwt: []
- apikey: []
parameters:
- name: id
required: true
schema:
oneOf:
- type: string
length: 24
metas: {}
- type: string
pattern: ^[a-z]+_.*$
metas: {}
metas: {}
in: path
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GET_Jobs_GetAScheduledJob_200_response'
'400':
description: Bad Request
'401':
description: Unauthorized
tags:
- jobs
description: Get a Scheduled Job
operationId: jobs/getAScheduledJob
put:
security:
- jwt: []
- apikey: []
parameters:
- name: id
required: true
schema:
oneOf:
- type: string
length: 24
metas: {}
- type: string
pattern: ^[a-z]+_.*$
metas: {}
metas: {}
in: path
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PUT_Jobs_UpdateAScheduledJob_200_response'
'400':
description: Bad Request
'401':
description: Unauthorized
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PUT_Jobs_UpdateAScheduledJob'
tags:
- jobs
description: Update a Scheduled Job
operationId: jobs/updateScheduledJob
delete:
security:
- jwt: []
- apikey: []
parameters:
- name: id
required: true
schema:
oneOf:
- type: string
length: 24
metas: {}
- type: string
pattern: ^[a-z]+_.*$
metas: {}
metas: {}
in: path
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DELETE_Jobs_DeleteAScheduledJob_200_response'
'400':
description: Bad Request
'401':
description: Unauthorized
tags:
- jobs
description: Delete a Scheduled Job
operationId: jobs/deleteScheduledJob
/api/jobs/upload-input:
post:
security:
- jwt: []
- apikey: []
parameters: []
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/POST_Jobs_UploadAnInputFileForImporting_200_response'
'401':
description: Unauthorized
tags:
- jobs
description: Upload an input file for importing
operationId: upload_an_input_file_for_importing
components:
schemas:
DELETE_Jobs_DeleteAScheduledJob_200_response:
type: object
properties:
_id:
type: string
description: The ID of the scheduled job
name:
type: string
description: The name of the scheduled job
sellerId:
type: string
description: The ID of the seller of the scheduled job.
timezone:
type: string
description: The timezone of the scheduled job.
scheduleFrequency:
oneOf:
- type: object
properties:
interval:
type: string
enum:
- WEEK
every:
type: integer
minimum: 1
maximum: 1000
description: The recurrence of the scheduled job.
time:
type: object
properties:
hour:
type: integer
minimum: 0
maximum: 23
minute:
type: integer
minimum: 0
maximum: 59
required:
- hour
- minute
description: The time when scheduled job should be executed.
endAt:
type: string
format: date-time
description: An ISO Timestamp indicating when the last execution of the scheduled job should occur.
repeatsOn:
type: array
items:
type: string
enum:
- SUNDAY
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
minItems: 1
required:
- interval
- every
- repeatsOn
- type: object
properties:
every:
type: integer
minimum: 1
maximum: 1000
description: The recurrence of the scheduled job.
time:
type: object
properties:
hour:
type: integer
minimum: 0
maximum: 23
minute:
type: integer
minimum: 0
maximum: 59
required:
- hour
- minute
description: The time when scheduled job should be executed.
endAt:
type: string
format: date-time
description: An ISO Timestamp indicating when the last execution of the scheduled job should occur.
interval:
type: string
enum:
- DAY
- MONTH
description: The interval of the scheduled job.
required:
- interval
- every
description: The schedule specification of the sheduled job.
task:
oneOf:
- type: object
properties:
type:
type: string
enum:
- report
- dashboard
description: The type of the task.
mail:
type: object
properties:
to:
type: array
items:
type: string
minItems: 1
description: The array of mail recipients.
timeWindow:
oneOf:
- type: object
properties:
mode:
type: string
enum:
- ROLLING_WINDOW
range:
type: object
properties:
interval:
type: integer
minimum: 0
unit:
type: string
enum:
- DAY
- WEEK
- MONTH
- YEAR
offset:
type: integer
minimum: 0
required:
- interval
- unit
- offset
required:
- mode
- range
- type: object
properties:
mode:
type: string
enum:
- EQUAL_TO_FREQUENCY
description: The mode of the time window.
default: EQUAL_TO_FREQUENCY
required:
- mode
reportTemplateId:
type: string
description: The ID of the template report.
reportType:
type: string
description: The type of the template report.
config:
type: object
properties:
hideFilters:
type: boolean
description: The configuration object of the report.
required:
- type
- mail
- reportTemplateId
- reportType
- type: object
properties:
type:
type: string
enum:
- dashboard
description: The type of the task.
mail:
type: object
properties:
to:
type: array
items:
type: string
minItems: 1
description: The array of mail recipients.
timeWindow:
oneOf:
- type: object
properties:
mode:
type: string
enum:
- ROLLING_WINDOW
range:
type: object
properties:
interval:
type: integer
minimum: 0
unit:
type: string
enum:
- DAY
- WEEK
- MONTH
- YEAR
offset:
type: integer
minimum: 0
required:
- interval
- unit
- offset
required:
- mode
- range
- type: object
properties:
mode:
type: string
enum:
- EQUAL_TO_FREQUENCY
description: The mode of the time window.
default: EQUAL_TO_FREQUENCY
required:
- mode
dashboardId:
type: string
description: The ID of the dashboard.
required:
- type
- mail
- dashboardId
description: The task specification of the scheduled job.
createdBy:
type: object
properties:
type:
type: string
enum:
- USER
- APP
- API_KEY
- SYSTEM
description: The type of the entity
id:
type: string
description: The ID of the entity
required:
- type
- id
description: The entity that created this scheduled job.
createdAt:
type: string
format: date-time
description: An ISO Timestamp indicating when the resource was created.
updatedAt:
type: string
format: date-time
description: An ISO Timestamp indicating when the resource was updated.
required:
- _id
- sellerId
- timezone
- createdAt
- updatedAt
GET_Jobs_GetAnJob_200_response:
oneOf:
- type: object
properties:
_id:
type: string
description: The ID of the job
sellerId:
type: string
description: The ID of the seller of the job
title:
type: string
description: The title of the job
type:
type: string
enum:
- transformJob
status:
type: string
enum:
- SCHEDULED
- RUNNING
- FAILED
- COMPLETED
- COMPLETED_WITH_ERRORS
description: The status of the job.
runAfter:
type: string
format: date-time
description: An ISO timestamp indicating after which time the job should be run.
startedAt:
type: string
format: date-time
description: An ISO timestamp indicating when the job started
finishedAt:
type: string
format: date-time
description: An ISO timestamp indicating when the job finished
payload:
oneOf:
- type: object
properties:
resource:
type: string
enum:
- ticketRangeInvalidation
csv:
type: string
description: An URL to download the CSV data.
json:
type: string
description: An URL to download the JSON data.
params:
type: object
properties:
batch:
type: string
description: A UUId indicating in which batch the tickets were created
groups:
type: array
items:
type: array
items:
type: integer
minimum: 0
minItems: 2
maxItems: 2
required:
- resource
- type: object
properties:
csv:
type: string
description: An URL to download the CSV data.
json:
type: string
description: An URL to download the JSON data.
required: []
required:
- _id
- sellerId
- type
- type: object
properties:
_id:
type: string
description: The ID of the job
sellerId:
type: string
description: The ID of the seller of the job
title:
type: string
description: The title of the job
status:
type: string
enum:
- SCHEDULED
- RUNNING
- FAILED
- COMPLETED
- COMPLETED_WITH_ERRORS
description: The status of the job.
runAfter:
type: string
format: date-time
description: An ISO timestamp indicating after which time the job should be run.
startedAt:
type: string
format: date-time
description: An ISO timestamp indicating when the job started
finishedAt:
type: string
format: date-time
description: An ISO timestamp indicating when the job finished
type:
type: string
enum:
- import
- export
- delete
- scheduledJob
description: The type of job.
required:
- _id
- sellerId
- type
PUT_Jobs_UpdateAScheduledJob_200_response:
type: object
properties:
_id:
type: string
description: The ID of the scheduled job
name:
type: string
description: The name of the scheduled job
sellerId:
type: string
description: The ID of the seller of the scheduled job.
timezone:
type: string
description: The timezone of the scheduled job.
scheduleFrequency:
oneOf:
- type: object
properties:
interval:
type: string
enum:
- WEEK
every:
type: integer
minimum: 1
maximum: 1000
description: The recurrence of the scheduled job.
time:
type: object
properties:
hour:
type: integer
minimum: 0
maximum: 23
minute:
type: integer
minimum: 0
maximum: 59
required:
- hour
- minute
description: The time when scheduled job should be executed.
endAt:
type: string
format: date-time
description: An ISO Timestamp indicating when the last execution of the scheduled job should occur.
repeatsOn:
type: array
items:
type: string
enum:
- SUNDAY
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
minItems: 1
required:
- interval
- every
- repeatsOn
- type: object
properties:
every:
type: integer
minimum: 1
maximum: 1000
description: The recurrence of the scheduled job.
time:
type: object
properties:
hour:
type: integer
minimum: 0
maximum: 23
minute:
type: integer
minimum: 0
maximum: 59
required:
- hour
- minute
description: The time when scheduled job should be executed.
endAt:
type: string
format: date-time
description: An ISO Timestamp indicating when the last execution of the scheduled job should occur.
interval:
type: string
enum:
- DAY
- MONTH
description: The interval of the scheduled job.
required:
- interval
- every
description: The schedule specification of the sheduled job.
task:
oneOf:
- type: object
properties:
type:
type: string
enum:
- report
- dashboard
description: The type of the task.
mail:
type: object
properties:
to:
type: array
items:
type: string
minItems: 1
description: The array of mail recipients.
timeWindow:
oneOf:
- type: object
properties:
mode:
type: string
enum:
- ROLLING_WINDOW
range:
type: object
properties:
interval:
type: integer
minimum: 0
unit:
type: string
enum:
- DAY
- WEEK
- MONTH
- YEAR
offset:
type: integer
minimum: 0
required:
- interval
- unit
- offset
required:
- mode
- range
- type: object
properties:
mode:
type: string
enum:
- EQUAL_TO_FREQUENCY
description: The mode of the time window.
default: EQUAL_TO_FREQUENCY
required:
- mode
reportTemplateId:
type: string
description: The ID of the template report.
reportType:
type: string
description: The type of the template report.
config:
type: object
properties:
hideFilters:
type: boolean
description: The configuration object of the report.
required:
- type
- mail
- reportTemplateId
- reportType
- type: object
properties:
type:
type: string
enum:
- dashboard
description: The type of the task.
mail:
type: object
properties:
to:
type: array
items:
type: string
minItems: 1
description: The array of mail recipients.
timeWindow:
oneOf:
- type: object
properties:
mode:
type: string
enum:
- ROLLING_WINDOW
range:
type: object
properties:
interval:
type: integer
minimum: 0
unit:
type: string
enum:
- DAY
- WEEK
- MONTH
- YEAR
offset:
type: integer
minimum: 0
required:
- interval
- unit
- offset
required:
- mode
- range
- type: object
properties:
mode:
type: string
enum:
- EQUAL_TO_FREQUENCY
description: The mode of the time window.
default: EQUAL_TO_FREQUENCY
required:
- mode
dashboardId:
type: string
description: The ID of the dashboard.
required:
- type
- mail
- dashboardId
description: The task specification of the scheduled job.
createdBy:
type: object
properties:
type:
type: string
enum:
- USER
- APP
- API_KEY
- SYSTEM
description: The type of the entity
id:
type: string
description: The ID of the entity
required:
- type
- id
description: The entity that created this scheduled job.
createdAt:
type: string
format: date-time
description: An ISO Timestamp indicating when the resource was created.
updatedAt:
type: string
format: date-time
description: An ISO Timestamp indicating when the resource was updated.
required:
- _id
- sellerId
- timezone
- createdAt
- updatedAt
POST_Jobs_CreateAnJob_202_response:
oneOf:
- type: object
properties:
_id:
type: string
description: The ID of the job
sellerId:
type: string
description: The ID of the seller of the job
title:
type: string
description: The title of the job
type:
type: string
enum:
- transformJob
status:
type: string
enum:
- SCHEDULED
- RUNNING
- FAILED
- COMPLETED
- COMPLETED_WITH_ERRORS
description: The status of the job.
runAfter:
type: string
format: date-time
description: An ISO timestamp indicating after which time the job should be run.
startedAt:
type: string
format: date-time
description: An ISO timestamp indicating when the job started
finishedAt:
type: string
format: date-time
description: An ISO timestamp indicating when the job finished
payload:
oneOf:
- type: object
properties:
resource:
type: string
enum:
- ticketRangeInvalidation
csv:
type: string
description: An URL to download the CSV data.
json:
type: string
description: An URL to download the JSON data.
params:
type: object
properties:
batch:
type: string
description: A UUId indicating in which batch the tickets were created
groups:
type: array
items:
type: array
items:
type: integer
minimum: 0
minItems: 2
maxItems: 2
required:
- resource
- type: object
properties:
csv:
type: string
description: An URL to download the CSV data.
json:
type: string
description: An URL to download the JSON data.
required: []
required:
- _id
- sellerId
- type
- type: object
properties:
_id:
type: string
description: The ID of the job
sellerId:
type: string
description: The ID of the seller of the job
title:
# --- truncated at 32 KB (82 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vivenu/refs/heads/main/openapi/vivenu-jobs-api-openapi.yml