api/v1/swagger/paths/erm_usage_items.yaml

   1 ---
   2 /erm/usage_items:
   3   get:
   4     x-mojo-to: ERM::UsageItems#list
   5     operationId: listErmUsageItems
   6     tags:
   7       - usage_item
   8     summary: List usage_items
   9     produces:
  10       - application/json
  11     parameters:
  12       - description: Case insensitive search on usage_item item_id
  13         in: query
  14         name: item_id
  15         required: false
  16         type: integer
  17       - description: Case insensitive search on usage_item item
  18         in: query
  19         name: item
  20         required: false
  21         type: string
  22       - description: Case insensitive search on usage_item usage_data_provider_id
  23         in: query
  24         name: usage_data_provider_id
  25         required: false
  26         type: string
  27       - description: Case insensitive search on usage_item platform
  28         in: query
  29         name: platform
  30         required: false
  31         type: string
  32       - description: Case insensitive search on usage_item publisher
  33         in: query
  34         name: publisher
  35         required: false
  36         type: string
  37       - name: x-koha-embed
  38         in: header
  39         required: false
  40         description: Embed list sent as a request header
  41         type: array
  42         items:
  43           type: string
  44           enum:
  45             - erm_usage_muses
  46             - erm_usage_yuses
  47         collectionFormat: csv
  48       - $ref: "../swagger.yaml#/parameters/match"
  49       - $ref: "../swagger.yaml#/parameters/order_by"
  50       - $ref: "../swagger.yaml#/parameters/page"
  51       - $ref: "../swagger.yaml#/parameters/per_page"
  52       - $ref: "../swagger.yaml#/parameters/q_param"
  53       - $ref: "../swagger.yaml#/parameters/q_body"
  54       - $ref: "../swagger.yaml#/parameters/q_header"
  55       - $ref: "../swagger.yaml#/parameters/request_id_header"
  56     responses:
  57       200:
  58         description: A list of usage_items
  59         schema:
  60           items:
  61             $ref: "../swagger.yaml#/definitions/erm_usage_item"
  62           type: array
  63       400:
  64         description: Bad request
  65         schema:
  66           $ref: "../swagger.yaml#/definitions/error"
  67       403:
  68         description: Access forbidden
  69         schema:
  70           $ref: "../swagger.yaml#/definitions/error"
  71       500:
  72         description: |-
  73           Internal server error. Possible `error_code` attribute values:
  74           * `internal_server_error`
  75         schema:
  76           $ref: "../swagger.yaml#/definitions/error"
  77       503:
  78         description: Under maintenance
  79         schema:
  80           $ref: "../swagger.yaml#/definitions/error"
  81     x-koha-authorization:
  82       permissions:
  83         erm: 1