Metadata Collections Select API documentation version v1
http://localhost/mod-finc-config
mod-finc-config API
This documents the API calls that can be made to query and manage metadata collections
Metadata Collections Select
Entity representing a metadata-collection
Get all metadata collections
get /finc-select/metadata-collections
Get all metadata collections
Query Parameters
- query: (string)
A 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 active=true sortBy username - orderBy: (string)
Order by field: field A, field B
- order: (one of desc, asc - default: desc)
Order
- offset: (integer - default: 0 - minimum: 0 - maximum: 2147483647)
Skip over a number of elements by specifying an offset value for the query
Example:
0 - limit: (integer - default: 10 - minimum: 0 - maximum: 2147483647)
Limit the number of elements returned in the response
Example:
10 - lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
HTTP status code 200
Returns item with a given ID
Body
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",
"$ref": "fincSelectMetadataCollection.json"
}
},
"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": "permitted (explicit)",
"note": "Note for test publication"
},
"collectionId": "coe-123",
"facetLabel": "012.1 21st Century COE",
"solrMegaCollections": [
"21st Century COE Program"
],
"selected": "yes",
"filters": []
}
],
"totalRecords": 1
}
HTTP status code 400
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.
Body
Media type: text/plain
Type: any
Example:
"unable to list metadata-collections -- malformed parameter 'query', syntax error at column 6"
HTTP status code 401
Not authorized to perform requested action
Body
Media type: text/plain
Type: any
Example:
"unable to list metadata-collections -- unauthorized"
HTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"metadata-collection not found"
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
internal server error, contact administratorEntity representing a metadata-collection
Get one metadata collection identified by id
get /finc-select/metadata-collections/{id}
Get one metadata collection identified by id
URI Parameters
- id: required (string)
Query Parameters
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
HTTP status code 200
Returns item with a given ID
Body
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": [
"permitted (interpreted)",
"permitted (explicit)",
"permitted (explicit) under conditions",
"prohibited (interpreted)",
"prohibited (explicit)",
"silent"
]
},
"note": {
"type": "string",
"description": "Note to LOD publication"
}
}
},
"collectionId": {
"type": "string",
"description": "Id of the collection"
},
"facetLabel": {
"type": "string",
"description": "Facet's label"
},
"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"
]
},
"filters": {
"type": "array",
"description": "Filters associated to this metadata collection",
"minItems": 0,
"items": {
"type": "string"
}
},
"generalNotes": {
"type": "string",
"description": "Some notes"
}
},
"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": "permitted (explicit)",
"note": "Note for test publication"
},
"collectionId": "coe-123",
"facetLabel": "012.1 21st Century COE",
"solrMegaCollections": [
"21st Century COE Program"
],
"selected": "yes",
"filters": [ "uuid-123", "uuid-789" ]
}
HTTP status code 401
Not authorized to perform requested action
Body
Media type: text/plain
Type: any
Example:
unable to get retrieve metadata-collection -- unauthorizedHTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"metadata-collection not found"
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
internal server error, contact administratorEntity representing a select
Put, if this metadata collection is selected resp. deselected
Retrieve select item with given {selectId}
Delete select item with given {selectId}
put /finc-select/metadata-collections/{id}/select
Put, if this metadata collection is selected resp. deselected
URI Parameters
- id: required (string)
Query Parameters
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
Body
Media 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
}HTTP status code 204
Item successfully updated
HTTP status code 400
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.
Body
Media type: text/plain
Type: any
Example:
"unable to update select -- malformed JSON at 13:4"
HTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"select not found"
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
internal server error, contact administratorget /finc-select/metadata-collections/{id}/select
Retrieve select item with given {selectId}
URI Parameters
- id: required (string)
Query Parameters
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
HTTP status code 200
Returns item with a given ID
Body
Media 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
}HTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"select not found"
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
internal server error, contact administratordelete /finc-select/metadata-collections/{id}/select
Delete select item with given {selectId}
URI Parameters
- id: required (string)
Query Parameters
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
HTTP status code 204
Item deleted successfully
HTTP status code 400
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.
Body
Media type: text/plain
Type: any
Example:
"unable to delete select -- constraint violation"
HTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"select not found"
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
Internal server error, contact administratorEntity representing a filter
Put list of filters to associate with this collections
Retrieve filter item with given {filterId}
Delete filter item with given {filterId}
put /finc-select/metadata-collections/{id}/filters
Put list of filters to associate with this collections
URI Parameters
- id: required (string)
Query Parameters
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Filters of a finc select metadata collection",
"description": "Filters associated with a finc select metadata collection",
"properties": {
"filters": {
"type": "array",
"description": "List of filters associated with this metadata collection",
"minItems": 0,
"items": {
"type": "string"
}
}
},
"required": [
"filters"
]
}
Example:
"filters": [
"uuid-123", "uuid-456"
]
HTTP status code 204
Item successfully updated
HTTP status code 400
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.
Body
Media type: text/plain
Type: any
Example:
"unable to update filter -- malformed JSON at 13:4"
HTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"filter not found"
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
internal server error, contact administratorget /finc-select/metadata-collections/{id}/filters
Retrieve filter item with given {filterId}
URI Parameters
- id: required (string)
Query Parameters
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
HTTP status code 200
Returns item with a given ID
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Filters of a finc select metadata collection",
"description": "Filters associated with a finc select metadata collection",
"properties": {
"filters": {
"type": "array",
"description": "List of filters associated with this metadata collection",
"minItems": 0,
"items": {
"type": "string"
}
}
},
"required": [
"filters"
]
}
Example:
"filters": [
"uuid-123", "uuid-456"
]
HTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"filter not found"
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
internal server error, contact administratordelete /finc-select/metadata-collections/{id}/filters
Delete filter item with given {filterId}
URI Parameters
- id: required (string)
Query Parameters
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
HTTP status code 204
Item deleted successfully
HTTP status code 400
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.
Body
Media type: text/plain
Type: any
Example:
"unable to delete filter -- constraint violation"
HTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"filter not found"
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
Internal server error, contact administrator