Introduction

These API specifications are automatically generated from the relevant RAML files, and specify how client modules may access the functionality provided by these important core modules.

  • view-1: Uses pop-up windows for each method and endpoint.
  • view-2: Uses one-page view to everything.

okapi

Label APIs view-1 view-2
okapi view-1 view-2

raml

Label APIs view-1 view-2
shared tenant view-1 view-2
shared-mod-login login view-1 view-2
shared-mod-permissions tenantPermissions view-1 view-2
shared-mod-permissions permissions view-1 view-2
shared-mod-users groups view-1 view-2
shared-mod-users users view-1 view-2
shared-mod-users addressTypes view-1 view-2
shared-mod-users proxiesFor view-1 view-2
shared-mod-users-bl mod-users-bl view-1 view-2
shared-codex codex view-1 view-2

raml-module-builder

Label APIs view-1 view-2
domain-models-api-interfaces admin view-1 view-2
domain-models-api-interfaces jobs view-1 view-2
domain-models-api-interfaces sample view-1 view-2

mod-circulation

Label APIs view-1 view-2
circulation view-1 view-2

mod-circulation-storage

Label APIs view-1 view-2
loan-storage view-1 view-2
loan-policy-storage view-1 view-2
loan-rules-storage view-1 view-2
request-storage view-1 view-2
fixed-due-date-schedule view-1 view-2

mod-configuration

Label APIs view-1 view-2
config view-1 view-2

mod-inventory

Label APIs view-1 view-2
inventory view-1 view-2

mod-inventory-storage

Label APIs view-1 view-2
holdings-storage view-1 view-2
instance-storage view-1 view-2
instance-format view-1 view-2
instance-type view-1 view-2
item-storage view-1 view-2
classification-type view-1 view-2
contributor-type view-1 view-2
contributor-name-type view-1 view-2
identifier-type view-1 view-2
loan-type view-1 view-2
material-type view-1 view-2
platform view-1 view-2
shelf-location view-1 view-2

mod-login-saml

Label APIs view-1 view-2
saml-login view-1 view-2

mod-user-import

Label APIs view-1 view-2
import view-1 view-2

mod-finance

Label APIs view-1 view-2
budget view-1 view-2
fiscal_year view-1 view-2
fund_distribution view-1 view-2
funds view-1 view-2
ledger view-1 view-2
tag view-1 view-2
transaction view-1 view-2

mod-notes

Label APIs view-1 view-2
note view-1 view-2

mod-notify

Label APIs view-1 view-2
notify view-1 view-2

mod-orders

Label APIs view-1 view-2
purchase_order view-1 view-2

mod-vendors

Label APIs view-1 view-2
vendor view-1 view-2
contact_category view-1 view-2
vendor_category view-1 view-2