api/v1/swagger/paths/background_jobs.yaml

   1 ---
   2 /background_jobs:
   3   get:
   4     x-mojo-to: BackgroundJobs#list
   5     operationId: listBackgroundJobs
   6     tags:
   7       - background_jobs
   8     summary: List background jobs
   9     produces:
  10       - application/json
  11     parameters:
  12       - name: status
  13         in: query
  14         description: Case insensative search on job status
  15         required: false
  16         type: string
  17       - name: progress
  18         in: query
  19         description: Case insensative search on job progress
  20         required: false
  21         type: string
  22       - name: size
  23         in: query
  24         description: Case insensative search on job size
  25         required: false
  26         type: string
  27       - name: patron_id
  28         in: query
  29         description: Case insensative search on job enqueuer id
  30         required: false
  31         type: string
  32       - name: tye
  33         in: query
  34         description: Case insensative search on job type
  35         required: false
  36         type: string
  37       - name: queue
  38         in: query
  39         description: Case insensative search on job queue
  40         required: false
  41         type: string
  42       - name: enqueued_on
  43         in: query
  44         description: Case insensative search on job enqueue date
  45         required: false
  46         type: string
  47       - name: started_on
  48         in: query
  49         description: Case insensative search on job start date
  50         required: false
  51         type: string
  52       - name: ended_on
  53         in: query
  54         description: Case insensative search on job end date
  55         required: false
  56         type: string
  57       - $ref: "../swagger.yaml#/parameters/match"
  58       - $ref: "../swagger.yaml#/parameters/order_by"
  59       - $ref: "../swagger.yaml#/parameters/page"
  60       - $ref: "../swagger.yaml#/parameters/per_page"
  61       - $ref: "../swagger.yaml#/parameters/q_param"
  62       - $ref: "../swagger.yaml#/parameters/q_body"
  63       - $ref: "../swagger.yaml#/parameters/q_header"
  64       - $ref: "../swagger.yaml#/parameters/request_id_header"
  65     responses:
  66       "200":
  67         description: A list of jobs
  68         schema:
  69           type: array
  70           items:
  71             $ref: "../swagger.yaml#/definitions/background_job"
  72       "403":
  73         description: Access forbidden
  74         schema:
  75           $ref: "../swagger.yaml#/definitions/error"
  76       "500":
  77         description: |
  78           Internal server error. Possible `error_code` attribute values:
  79
  80           * `internal_server_error`
  81         schema:
  82           $ref: "../swagger.yaml#/definitions/error"
  83       "503":
  84         description: Under maintenance
  85         schema:
  86           $ref: "../swagger.yaml#/definitions/error"
  87     x-koha-authorization:
  88       permissions:
  89         catalogue: "1"
  90 "/background_jobs/{background_job_id}":
  91   get:
  92     x-mojo-to: BackgroundJobs#get
  93     operationId: getBackgroundJob
  94     tags:
  95       - background_job
  96     summary: Get background job
  97     parameters:
  98       - $ref: "../swagger.yaml#/parameters/background_job_id_pp"
  99     produces:
 100       - application/json
 101     responses:
 102       "200":
 103         description: A background job
 104         schema:
 105           $ref: "../swagger.yaml#/definitions/background_job"
 106       "404":
 107         description: Background job not found
 108         schema:
 109           $ref: "../swagger.yaml#/definitions/error"
 110       "500":
 111         description: |
 112           Internal server error. Possible `error_code` attribute values:
 113
 114           * `internal_server_error`
 115         schema:
 116           $ref: "../swagger.yaml#/definitions/error"
 117       "503":
 118         description: Under maintenance
 119         schema:
 120           $ref: "../swagger.yaml#/definitions/error"
 121     x-koha-authorization:
 122       permissions:
 123         catalogue: "1"