API docs by Redocly

Mosaic integration API (0.0.1)

Mosaic integration API

No-op API to validate connectivity

Simple endpoint called by edge-orders to check API key correctness and verify that it can make calls to other endpoints. This endpoint has no business logic, always responds with 200 {"status":"SUCCESS"}, and is used purely for connectivity testing.

Responses

Response samples

Content type
application/json
{
  • "status": "SUCCESS"
}

Create a new order in FOLIO

Request Body schema: application/json
required

Mosaic Order object

orderTemplateId
string

The UUID format string

required
object (MosaicOrder)
id
string

The UUID format string

title
string

title of the material

assignedTo
string

The UUID format string

contributors
Array of objects

list of contributors to the material

publicationDate
string

date (year) of the material's publication

edition
string

edition of the material

details
object

details about this purchase order line

requesterName
string

who requested this purchase order line

selectorName
string

who selected this material

notes
Array of strings

free-form notes associated with this mosaic order

poLineDescription
string

description for poLine

internalNote
string

Internal note for this purchase order line

renewalNote
string

Renewal note for this purchase order line

referenceNumbers
object

Collection of reference number items

listUnitPrice
number

The per-item list price for physical or resources of 'Other' order format

listUnitPriceElectronic
number

The e-resource per-item list price

currency
string

An ISO currency code

quantityPhysical
integer

Quantity of physical items or resources of 'Other' order format

quantityElectronic
integer

Quantity of electronic items in this purchase order line

locations
Array of objects

Location records for this purchase order line

fundDistribution
Array of objects

Fund distribution records for this purchase order line

acquisitionMethod
string

UUID of the acquisition method for this purchase order line

acqUnitIds
Array of strings

acquisition unit ids associated with this purchase order

billTo
string

UUID for the billing address

shipTo
string

UUID for the shipping address

vendor
string

UUID for the vendor organization

workflowStatus
string

the workflow status for this purchase order

format
string

Order format (Physical Resource, Electronic Resource, P/E mix, Other)

physical
object

details of this purchase order line relating to physical materials

eresource
object

eresource-related details of this purchase order line

checkinItems
boolean

receiving workflow flag

customFields
Array of objects

Mosaic custom fields for either the PO or POL

metadata
object

Metadata about creation and changes to records

Responses

Request samples

Content type
application/json
{
  • "orderTemplateId": "string",
  • "orderData": {
    }
}

Response samples

Content type
text/plain
10001-1

Get Mosaic configuration

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "defaultTemplateId": "string",
  • "metadata": { }
}

Save Mosaic configuration

Request Body schema: application/json
required

Mosaic configuration object

id
required
string

The UUID format string

defaultTemplateId
required
string

The UUID format string

metadata
object

Metadata about creation and changes to records

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "defaultTemplateId": "string",
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "defaultTemplateId": "string",
  • "metadata": { }
}

Update Mosaic configuration

Request Body schema: application/json
required

Mosaic configuration object

id
required
string

The UUID format string

defaultTemplateId
required
string

The UUID format string

metadata
object

Metadata about creation and changes to records

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "defaultTemplateId": "string",
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "total_records": 0
}

Delete Mosaic configuration

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "total_records": 0
}