-
Notifications
You must be signed in to change notification settings - Fork 20
/
Copy pathrecord-bulk.raml
52 lines (47 loc) · 1.46 KB
/
record-bulk.raml
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
#%RAML 1.0
title: Inventory Storage Record Bulk API
version: v1.0
protocols: [ HTTP, HTTPS ]
baseUri: http://github.com/org/folio/mod-inventory-storage
documentation:
- title: Inventory Storage records Bulk Download API
content: <b>API for downloading a bulk set of instances or holdings IDs</b>
types:
ids: !include ids.json
errors: !include raml-util/schemas/errors.schema
traits:
orderable: !include raml-util/traits/orderable.raml
searchable: !include raml-util/traits/searchable.raml
validate: !include raml-util/traits/validation.raml
pageable: !include raml-util/traits/pageable.raml
resourceTypes:
collection-get: !include raml-util/rtypes/collection-get.raml
/record-bulk:
/ids:
displayName: Records ID Bulk Download API
type:
collection-get:
schemaCollection: ids
exampleCollection: !include examples/ids.json
get:
description: Retrieve a list of record IDs.
is: [
searchable: {description: "with valid searchable fields", example: "name=aaa"},
validate,
pageable
]
queryParameters:
field:
description: Field
type: string
enum: [id]
default: id
required: false
recordType:
description: Determines which record type UUIDs should be fetched
type: string
enum: [INSTANCE, HOLDING]
default: INSTANCE
required: false
limit:
default: 2147483647