Metadata Collections Select API documentation

Metadata Collections Select

Collection of metadata-collection items.

/finc-select/metadata-collections get post

get

Get all metadata collections

post

Create a new metadata-collection item.

Get all metadata collections

Request
Response

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 a list of metadata-collection items

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",
      "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": true
      "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": true,
      "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 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

Create a new metadata-collection item.

Request
Response

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#",
  "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",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of linked metadata source"
        },
        "name": {
          "type": "string",
          "description": "Name of linked metadata source"
        }
      },
      "required": [
        "id"
      ]
    },
    "metadataAvailable": {
      "type": "string",
      "enum": [
        "yes",
        "no",
        "undetermined"
      ]
    },
    "usageRestricted": {
      "type": "string",
      "enum": [
        "yes",
        "no"
      ]
    },
    "permitted": {
      "type": "boolean"
    },
    "freeContent": {
      "type": "string",
      "enum": [
        "yes",
        "no",
        "undetermined"
      ]
    },
    "lod": {
      "type": "object",
      "properties": {
        "publication": {
          "type": "string",
          "enum": [
            "permitted (interpreted)",
            "permitted (explicit)",
            "permitted (explicit) under conditions",
            "prohibited (interpreted)",
            "prohibited (explicit)",
            "silent"
          ]
        },
        "note": {
          "type": "string"
        }
      }
    },
    "collectionId": {
      "type": "string"
    },
    "facetLabel": {
      "type": "string"
    },
    "productIsil": {
      "type": "string"
    },
    "tickets": {
      "type": "array",
      "minItems": 0,
      "items": {
        "type": "string"
      }
    },
    "contentFiles": {
      "type": "array",
      "minItems": 0,
      "items": {
        "type": "string"
      }
    },
    "solrMegaCollections": {
      "type": "array",
      "minItems": 0,
      "items": {
        "type": "string"
      }
    },
    "selected": {
      "type": "boolean"
    },
    "filters": {
      "type": "array",
      "minItems": 0,
      "items": {
        "type": "object"
      }
    }
  },
  "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": true,
  "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": true,
  "filters": []
}

HTTP status code 201

Returns a newly created item, with server-controlled fields like 'id' populated

Headers

Location: required (string)
URI to the created metadata-collection item

Body

Media type: application/json

Type: any

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": true,
  "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": true,
  "filters": []
}

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 add metadata-collection -- malformed JSON at 13:3"

HTTP status code 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create metadata-collections -- unauthorized

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

/finc-select/metadata-collections/{id} get delete put

Entity representing a metadata-collection

get

Get one metadata collection identified by id

delete

Delete metadata-collection item with given {metadata-collectionId}

put

Update metadata-collection item with given {metadata-collectionId}

Get one metadata collection identified by id

Request
Response

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",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of linked metadata source"
        },
        "name": {
          "type": "string",
          "description": "Name of linked metadata source"
        }
      },
      "required": [
        "id"
      ]
    },
    "metadataAvailable": {
      "type": "string",
      "enum": [
        "yes",
        "no",
        "undetermined"
      ]
    },
    "usageRestricted": {
      "type": "string",
      "enum": [
        "yes",
        "no"
      ]
    },
    "permitted": {
      "type": "boolean"
    },
    "freeContent": {
      "type": "string",
      "enum": [
        "yes",
        "no",
        "undetermined"
      ]
    },
    "lod": {
      "type": "object",
      "properties": {
        "publication": {
          "type": "string",
          "enum": [
            "permitted (interpreted)",
            "permitted (explicit)",
            "permitted (explicit) under conditions",
            "prohibited (interpreted)",
            "prohibited (explicit)",
            "silent"
          ]
        },
        "note": {
          "type": "string"
        }
      }
    },
    "collectionId": {
      "type": "string"
    },
    "facetLabel": {
      "type": "string"
    },
    "productIsil": {
      "type": "string"
    },
    "tickets": {
      "type": "array",
      "minItems": 0,
      "items": {
        "type": "string"
      }
    },
    "contentFiles": {
      "type": "array",
      "minItems": 0,
      "items": {
        "type": "string"
      }
    },
    "solrMegaCollections": {
      "type": "array",
      "minItems": 0,
      "items": {
        "type": "string"
      }
    },
    "selected": {
      "type": "boolean"
    },
    "filters": {
      "type": "array",
      "minItems": 0,
      "items": {
        "type": "object"
      }
    }
  },
  "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": true,
  "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": true,
  "filters": []
}

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 administrator

Delete metadata-collection item with given {metadata-collectionId}

Request
Response

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 metadata-collection -- constraint violation"

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 administrator

Update metadata-collection item with given {metadata-collectionId}

Request
Response

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#",
  "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",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of linked metadata source"
        },
        "name": {
          "type": "string",
          "description": "Name of linked metadata source"
        }
      },
      "required": [
        "id"
      ]
    },
    "metadataAvailable": {
      "type": "string",
      "enum": [
        "yes",
        "no",
        "undetermined"
      ]
    },
    "usageRestricted": {
      "type": "string",
      "enum": [
        "yes",
        "no"
      ]
    },
    "permitted": {
      "type": "boolean"
    },
    "freeContent": {
      "type": "string",
      "enum": [
        "yes",
        "no",
        "undetermined"
      ]
    },
    "lod": {
      "type": "object",
      "properties": {
        "publication": {
          "type": "string",
          "enum": [
            "permitted (interpreted)",
            "permitted (explicit)",
            "permitted (explicit) under conditions",
            "prohibited (interpreted)",
            "prohibited (explicit)",
            "silent"
          ]
        },
        "note": {
          "type": "string"
        }
      }
    },
    "collectionId": {
      "type": "string"
    },
    "facetLabel": {
      "type": "string"
    },
    "productIsil": {
      "type": "string"
    },
    "tickets": {
      "type": "array",
      "minItems": 0,
      "items": {
        "type": "string"
      }
    },
    "contentFiles": {
      "type": "array",
      "minItems": 0,
      "items": {
        "type": "string"
      }
    },
    "solrMegaCollections": {
      "type": "array",
      "minItems": 0,
      "items": {
        "type": "string"
      }
    },
    "selected": {
      "type": "boolean"
    },
    "filters": {
      "type": "array",
      "minItems": 0,
      "items": {
        "type": "object"
      }
    }
  },
  "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": true,
  "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": true,
  "filters": []
}

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 metadata-collection -- malformed JSON at 13:4"

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 administrator

/finc-select/metadata-collections/{id}/select put get delete

Entity representing a select

put

Put, if this metadata collection is selected resp. deselected

get

Retrieve select item with given {selectId}

delete

Delete select item with given {selectId}

Put, if this metadata collection is selected resp. deselected

Request
Response

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"
    }
  },
  "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 administrator

Retrieve select item with given {selectId}

Request
Response

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"
    }
  },
  "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 administrator

Delete select item with given {selectId}

Request
Response

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 administrator

Metadata Collections Select API documentation version v1

mod-finc-config API