Metadata Collections (v1)

http://localhost/mod-finc-config

Table of contents

mod-finc-config API

This documents the API calls that can be made to query and manage metadata collections

Metadata Collections

Collection of metadata-collection items.

GET /finc-config/metadata-collections

Get all metadata collections

GET /finc-config/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]

Response 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 config",
  "properties": {
    "fincConfigMetadataCollections": {
      "type": "array",
      "description": "List of metadata collections in finc config",
      "id": "fincConfigMetadataCollectionsData",
      "items": {
        "type": "object",
        "$ref": "fincConfigMetadataCollection.json"
      }
    },
    "totalRecords": {
      "type": "integer"
    }
  },
  "required": [
    "metadataCollections",
    "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",
      "permittedFor": [
        "DE-15",
        "DE-14"
      ],
      "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"
      ]
    },
    {
      "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": "permitted (explicit)",
        "note": "Note for test publication"
      },
      "collectionId": "psa-459",
      "facetLabel": "093.8 21st Century Political Science",
      "solrMegaCollections": [
        "21st Century Political Science"
      ]
    }
  ],
  "totalRecords": 2
}

Response 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

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to list metadata-collections -- unauthorized

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

POST /finc-config/metadata-collections

Post new metadata collection

POST /finc-config/metadata-collections
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 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": [
            "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"
      }
    },
    "selectedBy": {
      "type": "array",
      "description": "List of isils which selected this metadata collection",
      "minItems": 0,
      "items": {
        "type": "string"
      }
    },
    "filters": {
      "type": "array",
      "description": "Filters associated to this metadata collection",
      "minItems": 0,
      "items": {
        "type": "object"
      }
    },
    "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",
  "permittedFor": [
    "DE-15",
    "DE-14"
  ],
  "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"
  ],
  "selectedBy": [ "DE-15", "DE-14" ],
  "filters": []
}

Response 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",
  "permittedFor": [
    "DE-15",
    "DE-14"
  ],
  "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"
  ],
  "selectedBy": [ "DE-15", "DE-14" ],
  "filters": []
}

Response 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"

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create metadata-collections -- unauthorized

Response 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "error.schema"
      }
    },
    "total_records": {
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

GET /finc-config/metadata-collections/{id}

Get one metadata collection identified by id

GET /finc-config/metadata-collections/{id}
URI Parameters
  • id: required (string)
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 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 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": [
            "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"
      }
    },
    "selectedBy": {
      "type": "array",
      "description": "List of isils which selected this metadata collection",
      "minItems": 0,
      "items": {
        "type": "string"
      }
    },
    "filters": {
      "type": "array",
      "description": "Filters associated to this metadata collection",
      "minItems": 0,
      "items": {
        "type": "object"
      }
    },
    "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",
  "permittedFor": [
    "DE-15",
    "DE-14"
  ],
  "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"
  ],
  "selectedBy": [ "DE-15", "DE-14" ],
  "filters": []
}

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"metadata-collection not found"

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

DELETE /finc-config/metadata-collections/{id}

Delete an metadata collection identified by id

DELETE /finc-config/metadata-collections/{id}
URI Parameters
  • id: required (string)
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 204

Item deleted successfully

Response 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"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"metadata-collection not found"

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

PUT /finc-config/metadata-collections/{id}

Put an metadata collection identified by id

PUT /finc-config/metadata-collections/{id}
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 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": [
            "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"
      }
    },
    "selectedBy": {
      "type": "array",
      "description": "List of isils which selected this metadata collection",
      "minItems": 0,
      "items": {
        "type": "string"
      }
    },
    "filters": {
      "type": "array",
      "description": "Filters associated to this metadata collection",
      "minItems": 0,
      "items": {
        "type": "object"
      }
    },
    "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",
  "permittedFor": [
    "DE-15",
    "DE-14"
  ],
  "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"
  ],
  "selectedBy": [ "DE-15", "DE-14" ],
  "filters": []
}

Response 204

Item successfully updated

Response 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"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"metadata-collection not found"

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator