http://localhost/mod-finc-config
This documents the API calls that can be made to query and manage metadata collections for all tenants/isils
Collection of metadata-collection items.
Get all metadata collections
GET /finc-config/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 metadataAvailable=("yes" or "no")) sortby label
Order by field: label, mdSource, metadataAvailable, usageRestricted, permittedFor, 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:
10Whether to include filter information in the response
Returns a list of metadata-collection items
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"description": "Collection of metadata collections with filters in finc config",
"javaType": "org.folio.rest.jaxrs.model.FincConfigMetadataCollectionWithFiltersCollection",
"properties": {
"fincConfigMetadataCollections": {
"type": "array",
"description": "List of metadata collections with filters in finc config",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Collection With Filters Schema",
"description": "Metadata collection with filters in finc config",
"javaType": "org.folio.rest.jaxrs.model.FincConfigMetadataCollectionWithFilters",
"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"
]
},
"permittedFor": {
"type": "array",
"description": "List of isils (libraries) this metadata collection is permitted for",
"minItems": 0,
"items": {
"type": "string"
}
},
"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"
}
},
"selectedBy": {
"type": "array",
"description": "List of isils which selected this metadata collection",
"minItems": 0,
"items": {
"type": "string"
}
},
"filteredBy": {
"type": "array",
"description": "List of filters which include this metadata collection",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Finc Select Filter Schema",
"description": "Filter of a metadata collection in finc select",
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string",
"description": "A unique name for this filter"
},
"type": {
"type": "string",
"description": "The type of this filter",
"enum": [
"Whitelist",
"Blacklist"
]
},
"filterFiles": {
"type": "array",
"id": "filterFiles",
"description": "List of filter files associated with this filter",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Finc Select Filter Files Schema",
"description": "The filter files which can be contained in a filter",
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string",
"description": "A unique name for this filter file"
},
"criteria": {
"type": "string",
"description": "The criteria of this filter"
},
"fileId": {
"type": "string",
"description": "UUID of the binary file (which is uploaded before this filter file document)"
},
"filename": {
"type": "string",
"description": "The file's filename"
},
"_delete": {
"type": "boolean",
"description": "Indicator if this filter file shall be deleted from it surrounding filter"
}
},
"required": [
"label",
"file"
],
"additionalProperties": false
}
},
"isil": {
"type": "string",
"description": "Isil of library using this filter"
},
"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": [
"label",
"type"
],
"additionalProperties": false
}
},
"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",
"collectionId",
"label",
"usageRestricted",
"solrMegaCollections"
],
"additionalProperties": false
}
},
"totalRecords": {
"type": "integer"
}
},
"required": [
"fincConfigMetadataCollections",
"totalRecords"
]
}Example:
{
"fincConfigMetadataCollections": [
{
"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",
"permittedFor": [
"DE-15",
"DE-14"
],
"freeContent": "undetermined",
"lod": {
"publication": "yes",
"note": "Note for test publication"
},
"collectionId": "coe-123",
"solrMegaCollections": [
"21st Century COE Program"
],
"selectedBy": [ "DE-15", "DE-14" ]
},
{
"id": "9a2427cd-4110-4bd9-b6f9-e3475631bbac",
"label": "21st Century Political Science Association",
"description": "This is a test metadata collection 2",
"mdSource": {
"id": "f6f03fb4-3368-4bc0-bc02-3bf6e19604a5",
"name": "Early Music Online"
},
"metadataAvailable": "yes",
"usageRestricted": "no",
"permittedFor": [
"DE-14"
],
"freeContent": "no",
"lod": {
"publication": "yes",
"note": "Note for test publication"
},
"collectionId": "psa-459",
"solrMegaCollections": [
"21st Century Political Science"
],
"selectedBy": [ "DE-14" ]
}
],
"totalRecords": 2
}
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 6Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to list metadata-collections -- unauthorizedInternal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administratorPost new metadata collection
POST /finc-config/metadata-collectionsMedia type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Collection Schema",
"description": "Metadata collection in finc config",
"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"
]
},
"permittedFor": {
"type": "array",
"description": "List of isils (libraries) this metadata collection is permitted for",
"minItems": 0,
"items": {
"type": "string"
}
},
"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"
}
},
"selectedBy": {
"type": "array",
"description": "List of isils which selected this metadata collection",
"minItems": 0,
"items": {
"type": "string"
}
},
"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",
"collectionId",
"label",
"usageRestricted",
"solrMegaCollections"
],
"additionalProperties": false
}Example:
{
"id": "6dd325f8-b1d5-4568-a0d7-aecf6b8d6123",
"label": "21st Century COE rogram",
"description": "This is a test metadata collection",
"mdSource": {
"id": "6dd325f8-b1d5-4568-a0d7-aecf6b8d6697",
"name": "Cambridge University Press Journals"
},
"metadataAvailable": "yes",
"usageRestricted": "no",
"permittedFor": [
"DE-14"
],
"freeContent": "undetermined",
"lod": {
"publication": "yes",
"note": "Note for test publication"
},
"collectionId": "coe-123",
"solrMegaCollections": [
"21st Century COE Program"
],
"selectedBy": [ "DE-15", "DE-14" ]
}
Returns a newly created item, with server-controlled fields like 'id' populated
URI to the created metadata-collection item
Media type: application/json
Type: any
Example:
{
"id": "6dd325f8-b1d5-4568-a0d7-aecf6b8d6123",
"label": "21st Century COE rogram",
"description": "This is a test metadata collection",
"mdSource": {
"id": "6dd325f8-b1d5-4568-a0d7-aecf6b8d6697",
"name": "Cambridge University Press Journals"
},
"metadataAvailable": "yes",
"usageRestricted": "no",
"permittedFor": [
"DE-14"
],
"freeContent": "undetermined",
"lod": {
"publication": "yes",
"note": "Note for test publication"
},
"collectionId": "coe-123",
"solrMegaCollections": [
"21st Century COE Program"
],
"selectedBy": [ "DE-15", "DE-14" ]
}
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 add metadata-collection -- malformed JSON at 13:3"
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to create metadata-collections -- unauthorizedValidation errors
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "errors.schema",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "error.schema",
"description": "An error",
"properties": {
"message": {
"type": "string",
"description": "Error message text"
},
"type": {
"type": "string",
"description": "Error message type"
},
"code": {
"type": "string",
"description": "Error message code"
},
"parameters": {
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "parameters.schema",
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"message"
]
}
},
"total_records": {
"description": "Total number of errors",
"type": "integer"
}
}
}Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
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-config/metadata-collections/{id}Whether to include filter information in the response
Returns item with a given ID
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Collection With Filters Schema",
"description": "Metadata collection with filters in finc config",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.FincConfigMetadataCollectionWithFilters",
"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"
]
},
"permittedFor": {
"type": "array",
"description": "List of isils (libraries) this metadata collection is permitted for",
"minItems": 0,
"items": {
"type": "string"
}
},
"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"
}
},
"selectedBy": {
"type": "array",
"description": "List of isils which selected this metadata collection",
"minItems": 0,
"items": {
"type": "string"
}
},
"filteredBy": {
"type": "array",
"description": "List of filters which include this metadata collection",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Finc Select Filter Schema",
"description": "Filter of a metadata collection in finc select",
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string",
"description": "A unique name for this filter"
},
"type": {
"type": "string",
"description": "The type of this filter",
"enum": [
"Whitelist",
"Blacklist"
]
},
"filterFiles": {
"type": "array",
"id": "filterFiles",
"description": "List of filter files associated with this filter",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Finc Select Filter Files Schema",
"description": "The filter files which can be contained in a filter",
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string",
"description": "A unique name for this filter file"
},
"criteria": {
"type": "string",
"description": "The criteria of this filter"
},
"fileId": {
"type": "string",
"description": "UUID of the binary file (which is uploaded before this filter file document)"
},
"filename": {
"type": "string",
"description": "The file's filename"
},
"_delete": {
"type": "boolean",
"description": "Indicator if this filter file shall be deleted from it surrounding filter"
}
},
"required": [
"label",
"file"
],
"additionalProperties": false
}
},
"isil": {
"type": "string",
"description": "Isil of library using this filter"
},
"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": [
"label",
"type"
],
"additionalProperties": false
}
},
"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",
"collectionId",
"label",
"usageRestricted",
"solrMegaCollections"
],
"additionalProperties": false
}Example:
{
"id": "6dd325f8-b1d5-4568-a0d7-aecf6b8d6123",
"label": "21st Century COE rogram",
"description": "This is a test metadata collection",
"mdSource": {
"id": "6dd325f8-b1d5-4568-a0d7-aecf6b8d6697",
"name": "Cambridge University Press Journals"
},
"metadataAvailable": "yes",
"usageRestricted": "no",
"permittedFor": [
"DE-14"
],
"freeContent": "undetermined",
"lod": {
"publication": "yes",
"note": "Note for test publication"
},
"collectionId": "coe-123",
"solrMegaCollections": [
"21st Century COE Program"
],
"selectedBy": [ "DE-15", "DE-14" ]
}
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 administratorDelete an metadata collection identified by id
DELETE /finc-config/metadata-collections/{id}Item deleted successfully
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 delete metadata-collection -- constraint violation"
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 administratorPut an metadata collection identified by id
PUT /finc-config/metadata-collections/{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 config",
"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"
]
},
"permittedFor": {
"type": "array",
"description": "List of isils (libraries) this metadata collection is permitted for",
"minItems": 0,
"items": {
"type": "string"
}
},
"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"
}
},
"selectedBy": {
"type": "array",
"description": "List of isils which selected this metadata collection",
"minItems": 0,
"items": {
"type": "string"
}
},
"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",
"collectionId",
"label",
"usageRestricted",
"solrMegaCollections"
],
"additionalProperties": false
}Example:
{
"id": "6dd325f8-b1d5-4568-a0d7-aecf6b8d6123",
"label": "21st Century COE rogram",
"description": "This is a test metadata collection",
"mdSource": {
"id": "6dd325f8-b1d5-4568-a0d7-aecf6b8d6697",
"name": "Cambridge University Press Journals"
},
"metadataAvailable": "yes",
"usageRestricted": "no",
"permittedFor": [
"DE-14"
],
"freeContent": "undetermined",
"lod": {
"publication": "yes",
"note": "Note for test publication"
},
"collectionId": "coe-123",
"solrMegaCollections": [
"21st Century COE Program"
],
"selectedBy": [ "DE-15", "DE-14" ]
}
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 metadata-collection -- malformed JSON at 13:4"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"metadata-collection 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