http://localhost/mod-finc-config
This documents the API calls that can be made to query and manage metadata collections for the current tenant/isil
Entity representing a metadata-collection
Get all metadata collections
GET /finc-select/metadata-collectionsA query expressed as a CQL string (see dev.folio.org/reference/glossary#cql) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.
Example:
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode
((label="Science*") and permitted="yes" and selected="no") sortby label
Order by field: label, mdSource, permitted, filters, freeContent
Order
How to calculate the totalRecords property. "exact" for the correct number, "estimated" for an estimation, "auto" to automatically select "exact" or "estimated", "none" for suppressing the totalRecords property. For details see https://github.com/folio-org/raml-module-builder#estimated-totalrecords
Example:
noneSkip over a number of elements by specifying an offset value for the query
Example:
0Limit the number of elements returned in the response. Using limit=0 will return totalRecords with the exact value. For details about totalRecords see https://github.com/folio-org/raml-module-builder#estimated-totalrecords
Example:
10Returns item with a given ID
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"description": "Collection of metadata collections in finc select",
"properties": {
"fincSelectMetadataCollections": {
"type": "array",
"id": "fincSelectMetadataCollectionData",
"description": "List of metadata collections for finc select",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Collection Schema",
"description": "Metadata collection in finc select",
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string",
"description": "A unique name for this metadata collection"
},
"description": {
"type": "string",
"description": "Description for this metadata collection"
},
"mdSource": {
"type": "object",
"description": "The metadata source this metadata collection belongs to",
"properties": {
"id": {
"type": "string",
"description": "Id of linked metadata source"
},
"name": {
"type": "string",
"description": "Name of linked metadata source"
}
},
"required": [
"id"
]
},
"metadataAvailable": {
"type": "string",
"description": "Indicates if metadata is available",
"enum": [
"yes",
"no",
"undetermined"
]
},
"usageRestricted": {
"type": "string",
"description": "Indicates if usage is restricted",
"enum": [
"yes",
"no"
]
},
"permitted": {
"type": "string",
"description": "Indicates if metadata collection is permitted for current tenant/isil",
"enum": [
"yes",
"no"
]
},
"freeContent": {
"type": "string",
"description": "Indicator is content is free",
"enum": [
"yes",
"no",
"undetermined"
]
},
"lod": {
"type": "object",
"description": "Indicator if LOD publication is permitted",
"properties": {
"publication": {
"type": "string",
"description": "Indicator if publication is permitted",
"enum": [
"yes",
"no",
"undetermined"
]
},
"note": {
"type": "string",
"description": "Note to LOD publication"
}
}
},
"collectionId": {
"type": "string",
"description": "Id of the collection"
},
"productIsil": {
"type": "string",
"description": "Isil of product"
},
"tickets": {
"type": "array",
"description": "List of links to corresponding tickets",
"minItems": 0,
"items": {
"type": "string"
}
},
"contentFiles": {
"type": "array",
"description": "URL to linked content file",
"minItems": 0,
"items": {
"type": "string"
}
},
"solrMegaCollections": {
"type": "array",
"description": "Link to solr mega collections",
"minItems": 0,
"items": {
"type": "string"
}
},
"selected": {
"type": "string",
"description": "Indicates if this metadata collection is selected by current tenant/isil",
"enum": [
"yes",
"no"
]
},
"generalNotes": {
"type": "string",
"description": "Some notes"
},
"metadata": {
"description": "Metadata about creation and changes, provided by the server (client should not provide)",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
}
},
"required": [
"id",
"label",
"usageRestricted",
"solrMegaCollections"
],
"additionalProperties": false
}
},
"totalRecords": {
"type": "integer"
}
},
"required": [
"sources",
"totalRecords"
]
}Example:
{
"metadataCollections": [
{
"id": "6dd325f8-b1d5-4568-a0d7-aecf6b8d6123",
"label": "21st Century COE Program",
"description": "This is a test metadata collection",
"mdSource": {
"id": "6dd325f8-b1d5-4568-a0d7-aecf6b8d6697",
"name": "Cambridge University Press Journals"
},
"metadataAvailable": "yes",
"usageRestricted": "no",
"permitted": "yes",
"freeContent": "undetermined",
"lod": {
"publication": "yes",
"note": "Note for test publication"
},
"collectionId": "coe-123",
"solrMegaCollections": [
"21st Century COE Program"
],
"selected": "yes"
}
],
"totalRecords": 1
}
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Media type: text/plain
Type: any
Example:
"unable to list metadata-collections -- malformed parameter 'query', syntax error at column 6"
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
"unable to list metadata-collections -- unauthorized"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"metadata-collection not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administratorGet one metadata collection identified by id
GET /finc-select/metadata-collections/{id}Returns item with a given ID
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Collection Schema",
"description": "Metadata collection in finc select",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string",
"description": "A unique name for this metadata collection"
},
"description": {
"type": "string",
"description": "Description for this metadata collection"
},
"mdSource": {
"type": "object",
"description": "The metadata source this metadata collection belongs to",
"properties": {
"id": {
"type": "string",
"description": "Id of linked metadata source"
},
"name": {
"type": "string",
"description": "Name of linked metadata source"
}
},
"required": [
"id"
]
},
"metadataAvailable": {
"type": "string",
"description": "Indicates if metadata is available",
"enum": [
"yes",
"no",
"undetermined"
]
},
"usageRestricted": {
"type": "string",
"description": "Indicates if usage is restricted",
"enum": [
"yes",
"no"
]
},
"permitted": {
"type": "string",
"description": "Indicates if metadata collection is permitted for current tenant/isil",
"enum": [
"yes",
"no"
]
},
"freeContent": {
"type": "string",
"description": "Indicator is content is free",
"enum": [
"yes",
"no",
"undetermined"
]
},
"lod": {
"type": "object",
"description": "Indicator if LOD publication is permitted",
"properties": {
"publication": {
"type": "string",
"description": "Indicator if publication is permitted",
"enum": [
"yes",
"no",
"undetermined"
]
},
"note": {
"type": "string",
"description": "Note to LOD publication"
}
}
},
"collectionId": {
"type": "string",
"description": "Id of the collection"
},
"productIsil": {
"type": "string",
"description": "Isil of product"
},
"tickets": {
"type": "array",
"description": "List of links to corresponding tickets",
"minItems": 0,
"items": {
"type": "string"
}
},
"contentFiles": {
"type": "array",
"description": "URL to linked content file",
"minItems": 0,
"items": {
"type": "string"
}
},
"solrMegaCollections": {
"type": "array",
"description": "Link to solr mega collections",
"minItems": 0,
"items": {
"type": "string"
}
},
"selected": {
"type": "string",
"description": "Indicates if this metadata collection is selected by current tenant/isil",
"enum": [
"yes",
"no"
]
},
"generalNotes": {
"type": "string",
"description": "Some notes"
},
"metadata": {
"description": "Metadata about creation and changes, provided by the server (client should not provide)",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
}
},
"required": [
"id",
"label",
"usageRestricted",
"solrMegaCollections"
],
"additionalProperties": false
}Example:
{
"id": "6dd325f8-b1d5-4568-a0d7-aecf6b8d6123",
"label": "21st Century COE Program",
"description": "This is a test metadata collection",
"mdSource": {
"id": "6dd325f8-b1d5-4568-a0d7-aecf6b8d6697",
"name": "Cambridge University Press Journals"
},
"metadataAvailable": "yes",
"usageRestricted": "no",
"permitted": "yes",
"freeContent": "undetermined",
"lod": {
"publication": "yes",
"note": "Note for test publication"
},
"collectionId": "coe-123",
"solrMegaCollections": [
"21st Century COE Program"
],
"selected": "yes"
}
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to get retrieve metadata-collection -- unauthorizedItem with a given ID not found
Media type: text/plain
Type: any
Example:
"metadata-collection not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administratorPut, if this metadata collection is selected resp. deselected
PUT /finc-select/metadata-collections/{id}/selectMedia type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Object to select resp. deselect metadata sources or collections",
"type": "object",
"title": "Select",
"properties": {
"select": {
"type": "boolean",
"description": "Boolean which describes if entity shall be selected resp. deselected"
}
},
"required": [
"select"
]
}Example:
{
"select": true
}Item successfully updated
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Media type: text/plain
Type: any
Example:
"unable to update select -- malformed JSON at 13:4"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"select not found"
Optimistic locking version conflict
Media type: text/plain
Type: any
Example:
version conflictInternal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator