http://localhost/mod-finc-config
This documents the API calls that can be made to query and manage metadata collections
Collection of metadata-source items.
Get all metadata sources
GET /finc-select/metadata-sourcesA 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="Journals*") and status=("active" or "technical implementation") and selected="none") sortby label
Order by field: label, sourceId, status, lastProcessed
Order
Skip over a number of elements by specifying an offset value for the query
Example:
0Limit the number of elements returned in the response
Example:
10Requested language. Optional. [lang=en]
Returns a list of metadata-source items
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"description": "Collection of metadata sources in finc select",
"properties": {
"fincSelectMetadataSources": {
"type": "array",
"id": "fincSelectMetadataSourcesData",
"description": "List of metadata sources for finc select",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Source Schema",
"description": "Metadata source in finc select",
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string",
"description": "A unique name for this metadata source"
},
"description": {
"type": "string",
"description": "A globally unique (UUID) identifier"
},
"status": {
"type": "string",
"description": "Current status of metadata source",
"enum": [
"active",
"closed",
"impossible",
"implementation",
"request"
]
},
"organization": {
"type": "object",
"description": "The organization delivering content of this metadata source",
"properties": {
"id": {
"type": "string",
"description": "Id of the the sources content’s organization, linked via uuid from organizations app."
},
"name": {
"type": "string",
"description": "Organization's name. If not given, it will be determined by backend module."
}
}
},
"contacts": {
"type": "array",
"description": "List of contacts",
"minItems": 0,
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Contact",
"description": "Contact schema",
"properties": {
"type": {
"type": "string",
"description": "The contact's type. This indicates if the contact originates from the users module or the organizations module.",
"enum": [
"user",
"contact"
]
},
"externalId": {
"type": "string",
"description": "The external id of this contact in the module specified by the type (users or organizations module)."
},
"name": {
"description": "The contact's name (lastName, firstName)",
"type": "string"
},
"role": {
"type": "string",
"description": "The contact's role",
"enum": [
"subject specialist",
"librarian",
"technical",
"vendor"
]
}
},
"required": [
"externalId",
"type",
"name",
"role"
]
}
},
"indexingLevel": {
"type": "string",
"description": "Level used for indexing (e.g. bibliographic)"
},
"generalNotes": {
"type": "string",
"description": "General notes not fitting into the other fields"
},
"lastProcessed": {
"type": "string",
"format": "date-time",
"description": "Date of last processing"
},
"tickets": {
"type": "array",
"description": "Links to internal tickets corresponding to this metadata source",
"minItems": 0,
"items": {
"type": "string"
}
},
"accessUrl": {
"type": "string",
"description": "URL to access metadata source"
},
"sourceId": {
"type": "integer",
"description": "The source id"
},
"solrShard": {
"type": "string",
"description": "Used solr shard",
"enum": [
"SLUB DBoD",
"SLUB dswarm",
"UBL ai",
"UBL DNB",
"UBL main"
]
},
"deliveryMethods": {
"type": "array",
"description": "Available delivery methods (e.g. API download)",
"minItems": 0,
"items": {
"type": "string"
}
},
"formats": {
"type": "array",
"description": "Available formats (e.g. MARC)",
"minItems": 0,
"items": {
"type": "string"
}
},
"updateRhythm": {
"type": "string",
"description": "Metadata source's update rhythm"
},
"inferiorTo": {
"type": "array",
"description": "Link to other metadata sources",
"minItems": 0,
"items": {
"type": "string"
}
},
"selected": {
"type": "string",
"description": "Indicator if current tenant/library has selected this metadata source",
"enum": [
"all",
"some",
"none"
]
},
"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",
"status",
"sourceId"
],
"additionalProperties": false
}
},
"totalRecords": {
"type": "integer"
}
},
"required": [
"sources",
"totalRecords"
]
}Example:
{
"metadataSources": [
{
"id": "6dd325f8-b1d5-4568-a0d7-aecf6b8d6697",
"label": "Cambridge University Press Journals",
"description": "This is a test metadata source",
"status": "active",
"contacts": [
{
"type": "user",
"externalId": "fcfaca0b-12e7-467e-b503-d44a44d60a62",
"name": "Doe, John",
"role": "librarian"
},
{
"type": "contact",
"externalId": "01771c0a-a890-4488-b5e9-366aa697bd93",
"name": "Doe, Jane",
"role": "vendor"
}
],
"indexingLevel": "bibliographic",
"generalNotes": "Test licensing note",
"lastProcessed": "2018-01-01",
"tickets": [
"http://redmine.de/123",
"http://redmine.de/456"
],
"accessUrl": "http://access.url",
"sourceId": 1,
"solrShard": "UBL main",
"deliveryMethods": [
"API Download"
],
"formats": [
"csv"
],
"updateRhythm": "monthly",
"inferiorTo": [
"uuid-789",
"uuid-123"
],
"selected": "all"
}
],
"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-sources -- malformed parameter 'query', syntax error at column 6Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to list metadata-sources -- unauthorizedInternal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administratorCreate a new metadata-source item.
POST /finc-select/metadata-sourcesRequested language. Optional. [lang=en]
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Source Schema",
"description": "Metadata source in finc select",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string",
"description": "A unique name for this metadata source"
},
"description": {
"type": "string",
"description": "A globally unique (UUID) identifier"
},
"status": {
"type": "string",
"description": "Current status of metadata source",
"enum": [
"active",
"closed",
"impossible",
"implementation",
"request"
]
},
"organization": {
"type": "object",
"description": "The organization delivering content of this metadata source",
"properties": {
"id": {
"type": "string",
"description": "Id of the the sources content’s organization, linked via uuid from organizations app."
},
"name": {
"type": "string",
"description": "Organization's name. If not given, it will be determined by backend module."
}
}
},
"contacts": {
"type": "array",
"description": "List of contacts",
"minItems": 0,
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Contact",
"description": "Contact schema",
"properties": {
"type": {
"type": "string",
"description": "The contact's type. This indicates if the contact originates from the users module or the organizations module.",
"enum": [
"user",
"contact"
]
},
"externalId": {
"type": "string",
"description": "The external id of this contact in the module specified by the type (users or organizations module)."
},
"name": {
"description": "The contact's name (lastName, firstName)",
"type": "string"
},
"role": {
"type": "string",
"description": "The contact's role",
"enum": [
"subject specialist",
"librarian",
"technical",
"vendor"
]
}
},
"required": [
"externalId",
"type",
"name",
"role"
]
}
},
"indexingLevel": {
"type": "string",
"description": "Level used for indexing (e.g. bibliographic)"
},
"generalNotes": {
"type": "string",
"description": "General notes not fitting into the other fields"
},
"lastProcessed": {
"type": "string",
"format": "date-time",
"description": "Date of last processing"
},
"tickets": {
"type": "array",
"description": "Links to internal tickets corresponding to this metadata source",
"minItems": 0,
"items": {
"type": "string"
}
},
"accessUrl": {
"type": "string",
"description": "URL to access metadata source"
},
"sourceId": {
"type": "integer",
"description": "The source id"
},
"solrShard": {
"type": "string",
"description": "Used solr shard",
"enum": [
"SLUB DBoD",
"SLUB dswarm",
"UBL ai",
"UBL DNB",
"UBL main"
]
},
"deliveryMethods": {
"type": "array",
"description": "Available delivery methods (e.g. API download)",
"minItems": 0,
"items": {
"type": "string"
}
},
"formats": {
"type": "array",
"description": "Available formats (e.g. MARC)",
"minItems": 0,
"items": {
"type": "string"
}
},
"updateRhythm": {
"type": "string",
"description": "Metadata source's update rhythm"
},
"inferiorTo": {
"type": "array",
"description": "Link to other metadata sources",
"minItems": 0,
"items": {
"type": "string"
}
},
"selected": {
"type": "string",
"description": "Indicator if current tenant/library has selected this metadata source",
"enum": [
"all",
"some",
"none"
]
},
"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",
"status",
"sourceId"
],
"additionalProperties": false
}Example:
{
"id": "6dd325f8-b1d5-4568-a0d7-aecf6b8d6697",
"label": "Cambridge University Press Journals",
"description": "This is a test metadata source",
"status": "active",
"contacts": [
{
"type": "user",
"externalId": "fcfaca0b-12e7-467e-b503-d44a44d60a62",
"name": "Doe, John",
"role": "librarian"
},
{
"type": "contact",
"externalId": "01771c0a-a890-4488-b5e9-366aa697bd93",
"name": "Doe, Jane",
"role": "vendor"
}
],
"indexingLevel": "bibliographic",
"generalNotes": "Test licensing note",
"lastProcessed": "2018-01-01",
"tickets": [
"http://redmine.de/123",
"http://redmine.de/456"
],
"accessUrl": "http://access.url",
"sourceId": 1,
"solrShard": "UBL main",
"deliveryMethods": [
"API Download"
],
"formats": [
"csv"
],
"updateRhythm": "monthly",
"inferiorTo": [
"uuid-789",
"uuid-123"
],
"selected": "all"
}
Returns a newly created item, with server-controlled fields like 'id' populated
URI to the created metadata-source item
Media type: application/json
Type: any
Example:
{
"id": "6dd325f8-b1d5-4568-a0d7-aecf6b8d6697",
"label": "Cambridge University Press Journals",
"description": "This is a test metadata source",
"status": "active",
"contacts": [
{
"type": "user",
"externalId": "fcfaca0b-12e7-467e-b503-d44a44d60a62",
"name": "Doe, John",
"role": "librarian"
},
{
"type": "contact",
"externalId": "01771c0a-a890-4488-b5e9-366aa697bd93",
"name": "Doe, Jane",
"role": "vendor"
}
],
"indexingLevel": "bibliographic",
"generalNotes": "Test licensing note",
"lastProcessed": "2018-01-01",
"tickets": [
"http://redmine.de/123",
"http://redmine.de/456"
],
"accessUrl": "http://access.url",
"sourceId": 1,
"solrShard": "UBL main",
"deliveryMethods": [
"API Download"
],
"formats": [
"csv"
],
"updateRhythm": "monthly",
"inferiorTo": [
"uuid-789",
"uuid-123"
],
"selected": "all"
}
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-source -- malformed JSON at 13:3"
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to create metadata-sources -- unauthorizedInternal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administratorGet one metadata source identified by id
GET /finc-select/metadata-sources/{id}Requested language. Optional. [lang=en]
Returns item with a given ID
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Source Schema",
"description": "Metadata source in finc select",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string",
"description": "A unique name for this metadata source"
},
"description": {
"type": "string",
"description": "A globally unique (UUID) identifier"
},
"status": {
"type": "string",
"description": "Current status of metadata source",
"enum": [
"active",
"closed",
"impossible",
"implementation",
"request"
]
},
"organization": {
"type": "object",
"description": "The organization delivering content of this metadata source",
"properties": {
"id": {
"type": "string",
"description": "Id of the the sources content’s organization, linked via uuid from organizations app."
},
"name": {
"type": "string",
"description": "Organization's name. If not given, it will be determined by backend module."
}
}
},
"contacts": {
"type": "array",
"description": "List of contacts",
"minItems": 0,
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Contact",
"description": "Contact schema",
"properties": {
"type": {
"type": "string",
"description": "The contact's type. This indicates if the contact originates from the users module or the organizations module.",
"enum": [
"user",
"contact"
]
},
"externalId": {
"type": "string",
"description": "The external id of this contact in the module specified by the type (users or organizations module)."
},
"name": {
"description": "The contact's name (lastName, firstName)",
"type": "string"
},
"role": {
"type": "string",
"description": "The contact's role",
"enum": [
"subject specialist",
"librarian",
"technical",
"vendor"
]
}
},
"required": [
"externalId",
"type",
"name",
"role"
]
}
},
"indexingLevel": {
"type": "string",
"description": "Level used for indexing (e.g. bibliographic)"
},
"generalNotes": {
"type": "string",
"description": "General notes not fitting into the other fields"
},
"lastProcessed": {
"type": "string",
"format": "date-time",
"description": "Date of last processing"
},
"tickets": {
"type": "array",
"description": "Links to internal tickets corresponding to this metadata source",
"minItems": 0,
"items": {
"type": "string"
}
},
"accessUrl": {
"type": "string",
"description": "URL to access metadata source"
},
"sourceId": {
"type": "integer",
"description": "The source id"
},
"solrShard": {
"type": "string",
"description": "Used solr shard",
"enum": [
"SLUB DBoD",
"SLUB dswarm",
"UBL ai",
"UBL DNB",
"UBL main"
]
},
"deliveryMethods": {
"type": "array",
"description": "Available delivery methods (e.g. API download)",
"minItems": 0,
"items": {
"type": "string"
}
},
"formats": {
"type": "array",
"description": "Available formats (e.g. MARC)",
"minItems": 0,
"items": {
"type": "string"
}
},
"updateRhythm": {
"type": "string",
"description": "Metadata source's update rhythm"
},
"inferiorTo": {
"type": "array",
"description": "Link to other metadata sources",
"minItems": 0,
"items": {
"type": "string"
}
},
"selected": {
"type": "string",
"description": "Indicator if current tenant/library has selected this metadata source",
"enum": [
"all",
"some",
"none"
]
},
"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",
"status",
"sourceId"
],
"additionalProperties": false
}Example:
{
"id": "6dd325f8-b1d5-4568-a0d7-aecf6b8d6697",
"label": "Cambridge University Press Journals",
"description": "This is a test metadata source",
"status": "active",
"contacts": [
{
"type": "user",
"externalId": "fcfaca0b-12e7-467e-b503-d44a44d60a62",
"name": "Doe, John",
"role": "librarian"
},
{
"type": "contact",
"externalId": "01771c0a-a890-4488-b5e9-366aa697bd93",
"name": "Doe, Jane",
"role": "vendor"
}
],
"indexingLevel": "bibliographic",
"generalNotes": "Test licensing note",
"lastProcessed": "2018-01-01",
"tickets": [
"http://redmine.de/123",
"http://redmine.de/456"
],
"accessUrl": "http://access.url",
"sourceId": 1,
"solrShard": "UBL main",
"deliveryMethods": [
"API Download"
],
"formats": [
"csv"
],
"updateRhythm": "monthly",
"inferiorTo": [
"uuid-789",
"uuid-123"
],
"selected": "all"
}
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"metadata-source not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administratorDelete metadata-source item with given {metadata-sourceId}
DELETE /finc-select/metadata-sources/{id}Requested language. Optional. [lang=en]
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-source -- constraint violation"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"metadata-source not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administratorUpdate metadata-source item with given {metadata-sourceId}
PUT /finc-select/metadata-sources/{id}Requested language. Optional. [lang=en]
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Source Schema",
"description": "Metadata source in finc select",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string",
"description": "A unique name for this metadata source"
},
"description": {
"type": "string",
"description": "A globally unique (UUID) identifier"
},
"status": {
"type": "string",
"description": "Current status of metadata source",
"enum": [
"active",
"closed",
"impossible",
"implementation",
"request"
]
},
"organization": {
"type": "object",
"description": "The organization delivering content of this metadata source",
"properties": {
"id": {
"type": "string",
"description": "Id of the the sources content’s organization, linked via uuid from organizations app."
},
"name": {
"type": "string",
"description": "Organization's name. If not given, it will be determined by backend module."
}
}
},
"contacts": {
"type": "array",
"description": "List of contacts",
"minItems": 0,
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Contact",
"description": "Contact schema",
"properties": {
"type": {
"type": "string",
"description": "The contact's type. This indicates if the contact originates from the users module or the organizations module.",
"enum": [
"user",
"contact"
]
},
"externalId": {
"type": "string",
"description": "The external id of this contact in the module specified by the type (users or organizations module)."
},
"name": {
"description": "The contact's name (lastName, firstName)",
"type": "string"
},
"role": {
"type": "string",
"description": "The contact's role",
"enum": [
"subject specialist",
"librarian",
"technical",
"vendor"
]
}
},
"required": [
"externalId",
"type",
"name",
"role"
]
}
},
"indexingLevel": {
"type": "string",
"description": "Level used for indexing (e.g. bibliographic)"
},
"generalNotes": {
"type": "string",
"description": "General notes not fitting into the other fields"
},
"lastProcessed": {
"type": "string",
"format": "date-time",
"description": "Date of last processing"
},
"tickets": {
"type": "array",
"description": "Links to internal tickets corresponding to this metadata source",
"minItems": 0,
"items": {
"type": "string"
}
},
"accessUrl": {
"type": "string",
"description": "URL to access metadata source"
},
"sourceId": {
"type": "integer",
"description": "The source id"
},
"solrShard": {
"type": "string",
"description": "Used solr shard",
"enum": [
"SLUB DBoD",
"SLUB dswarm",
"UBL ai",
"UBL DNB",
"UBL main"
]
},
"deliveryMethods": {
"type": "array",
"description": "Available delivery methods (e.g. API download)",
"minItems": 0,
"items": {
"type": "string"
}
},
"formats": {
"type": "array",
"description": "Available formats (e.g. MARC)",
"minItems": 0,
"items": {
"type": "string"
}
},
"updateRhythm": {
"type": "string",
"description": "Metadata source's update rhythm"
},
"inferiorTo": {
"type": "array",
"description": "Link to other metadata sources",
"minItems": 0,
"items": {
"type": "string"
}
},
"selected": {
"type": "string",
"description": "Indicator if current tenant/library has selected this metadata source",
"enum": [
"all",
"some",
"none"
]
},
"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",
"status",
"sourceId"
],
"additionalProperties": false
}Example:
{
"id": "6dd325f8-b1d5-4568-a0d7-aecf6b8d6697",
"label": "Cambridge University Press Journals",
"description": "This is a test metadata source",
"status": "active",
"contacts": [
{
"type": "user",
"externalId": "fcfaca0b-12e7-467e-b503-d44a44d60a62",
"name": "Doe, John",
"role": "librarian"
},
{
"type": "contact",
"externalId": "01771c0a-a890-4488-b5e9-366aa697bd93",
"name": "Doe, Jane",
"role": "vendor"
}
],
"indexingLevel": "bibliographic",
"generalNotes": "Test licensing note",
"lastProcessed": "2018-01-01",
"tickets": [
"http://redmine.de/123",
"http://redmine.de/456"
],
"accessUrl": "http://access.url",
"sourceId": 1,
"solrShard": "UBL main",
"deliveryMethods": [
"API Download"
],
"formats": [
"csv"
],
"updateRhythm": "monthly",
"inferiorTo": [
"uuid-789",
"uuid-123"
],
"selected": "all"
}
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-source -- malformed JSON at 13:4"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"metadata-source not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administratorGet metadata collections assigned to this metadata source
GET /finc-select/metadata-sources/{id}/collectionsPost, if all metadata collections of this source are selected resp. deselected
PUT /finc-select/metadata-sources/{id}/collections/select-allRequested language. Optional. [lang=en]
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
}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-all -- malformed JSON at 13:4"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"select-all not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administratorRetrieve select-all item with given {select-allId}
GET /finc-select/metadata-sources/{id}/collections/select-allRequested language. Optional. [lang=en]
Returns item with a given ID
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
}Item with a given ID not found
Media type: text/plain
Type: any
Example:
"select-all not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administratorDelete select-all item with given {select-allId}
DELETE /finc-select/metadata-sources/{id}/collections/select-allRequested language. Optional. [lang=en]
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 select-all -- constraint violation"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"select-all not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administrator