Skip to content
Permalink
master
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time
#%RAML 1.0
title: Note Links
version: v1.0.0
baseUri: http://github.com/org/folio/mod-notes
documentation:
- title: mod-notes Links API
content: This documents the API calls that can be made to query and manage note links of the system
types:
noteLinksPut: !include types/link/noteLinksPut.json
errors: !include raml-util/schemas/errors.schema
noteCollection: !include types/notes/noteCollection.json
note: !include types/notes/note.json
traits:
validate: !include raml-util/traits/validation.raml
language: !include raml-util/traits/language.raml
pageable: !include raml-util/traits/pageable.raml
searchable: !include raml-util/traits/searchable.raml
orderable: !include raml-util/traits/orderable.raml
/note-links:
/type/{type}/id/{id}/:
put:
is: [validate]
description: Add links to specified list of notes
body:
application/json:
type: noteLinksPut
example:
strict: false
value: !include examples/link/noteLinksPut.json
responses:
204:
description: "Links successfully added"
404:
description: "One of the notes from request is not found"
body:
text/plain:
example: |
"Note with id '62d00c36-a94f-434d-9cd2-c7ea159303da' not found"
400:
description: "Bad request, e.g. malformed request body. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response."
body:
text/plain:
example: |
"unable to update note links -- malformed JSON at 13:4"
500:
description: "Internal server error"
body:
text/plain:
example: "internal server error, contact administrator"
/domain/{domain}/type/{type}/id/{id}/:
get:
is: [
validate,
pageable
]
description: Return a list of notes by status
queryParameters:
search:
displayName: Search term
type: string
description: Partial match case-insensitive search term for note title and note details.
example: important
required: false
noteType:
displayName: Note type
type: string[]
description: Search string for note type. Note(s) is returned only if it equals to
specified word or sequence of words in the titleseparated by com type name. Multiple types should be
declared with query parameter sequentially as follows "noteType=a&noteType=b".
Search is case sensitive.
example: ["General support"]
required: false
status:
displayName: Selection status
type: string
description: Filtering records by status. Possible values are ASSIGNED, UNASSIGNED, ALL.
example: ASSIGNED
required: false
default: ALL
orderBy:
displayName: Field to order by
type: string
description: Field by which notes are ordered. Possible values are status, title, content, linksNumber, noteType, updatedDate.
The default ascending sorting is applied for status, title, content, linksNumber, noteType parameters.
For updatedDate is descending. Explicit selection of sorting can be set by using order query parameter.
required: false
default: status
order:
displayName: Order of notes
type: string
description: indicates order of notes. Possible values asc, desc.
example: asc
required: false
default: default
responses:
200:
description: "Return a list of notes"
body:
application/json:
type: noteCollection
example:
strict: false
value: !include examples/noteCollection.sample
400:
description: "Bad request, e.g. malformed request body. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response."
body:
text/plain:
example: |
"unable to get list -- malformed JSON at 13:4"
401:
description: "Not authorized to perform requested action"
body:
text/plain:
example: "unable to list -- unauthorized"
500:
description: "Internal server error"
body:
text/plain:
example: "internal server error, contact administrator"