Filters for Finc Config (v1)

http://localhost/mod-finc-config

Table of contents

mod-finc-config API

This documents the API calls that can be made to query filters of metadata collections

Finc config filters

Collection of filter items.

GET /finc-config/filters

Get all filters

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

((label="test*") and type="Blacklist") sortby label
  • orderBy: (string)

    Order by field: label, type

  • 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 filter items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Collection of filters in finc select",
  "properties": {
    "fincSelectFilters": {
      "type": "array",
      "id": "fincSelectFilters",
      "description": "List of filters in finc select",
      "items": {
        "type": "object",
        "$ref": "fincSelectFilter.json"
      }
    },
    "totalRecords": {
      "type": "integer"
    }
  },
  "required": [
    "fincSelectFilters",
    "totalRecords"
  ]
}

Example:

{
  "fincSelectFilters": [
    {
      "id": "084befb6-a264-4dd0-ade9-1aaae390c483",
      "label": "Holdings 1",
      "type": "Whitelist",
      "filterFiles": [
        {
          "label": "Holdings",
          "criteria": "Column: ISSN",
          "filename": "filterFile.txt",
          "fileId": "aa9202b7-754a-414a-8bf6-378df78e5985"
        }
      ],
      "isil": "DE-15"
    }
  ],
  "totalRecords": 1
}

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 filters -- 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 filters -- 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/filters

Post new filter

POST /finc-config/filters
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": "Finc Select Filter Schema",
  "description": "Filter of a metadata collection in finc select",
  "type": "object",
  "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",
        "$ref": "fincSelectFilterFile.json"
      }
    },
    "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",
      "$ref": "../raml-util/schemas/metadata.schema"
    }
  },
  "required": [
    "label",
    "type"
  ],
  "additionalProperties": false
}

Example:

{
  "id": "084befb6-a264-4dd0-ade9-1aaae390c483",
  "label": "Holdings 1",
  "type": "Whitelist",
  "filterFiles": [
    {
      "label": "Holdings",
      "criteria": "Column: ISSN",
      "filename": "filterFile.txt",
      "fileId": "aa9202b7-754a-414a-8bf6-378df78e5985"
    }
  ],
  "isil": "DE-15"
}

Response 201

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

Headers
  • Location: required (string)

    URI to the created filter item

Body

Media type: application/json

Type: any

Example:

{
  "id": "084befb6-a264-4dd0-ade9-1aaae390c483",
  "label": "Holdings 1",
  "type": "Whitelist",
  "filterFiles": [
    {
      "label": "Holdings",
      "criteria": "Column: ISSN",
      "filename": "filterFile.txt",
      "fileId": "aa9202b7-754a-414a-8bf6-378df78e5985"
    }
  ],
  "isil": "DE-15"
}

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 filter -- malformed JSON at 13:3"

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create filters -- 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": {
      "description": "Total number of errors",
      "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/filters/{id}

Get one finc select filter identified by id

GET /finc-config/filters/{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": "Finc Select Filter Schema",
  "description": "Filter of a metadata collection in finc select",
  "type": "object",
  "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",
        "$ref": "fincSelectFilterFile.json"
      }
    },
    "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",
      "$ref": "../raml-util/schemas/metadata.schema"
    }
  },
  "required": [
    "label",
    "type"
  ],
  "additionalProperties": false
}

Example:

{
  "id": "084befb6-a264-4dd0-ade9-1aaae390c483",
  "label": "Holdings 1",
  "type": "Whitelist",
  "filterFiles": [
    {
      "label": "Holdings",
      "criteria": "Column: ISSN",
      "filename": "filterFile.txt",
      "fileId": "aa9202b7-754a-414a-8bf6-378df78e5985"
    }
  ],
  "isil": "DE-15"
}

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"filter 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/filters/{id}

Put a filter identified by id

PUT /finc-config/filters/{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": "Finc Select Filter Schema",
  "description": "Filter of a metadata collection in finc select",
  "type": "object",
  "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",
        "$ref": "fincSelectFilterFile.json"
      }
    },
    "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",
      "$ref": "../raml-util/schemas/metadata.schema"
    }
  },
  "required": [
    "label",
    "type"
  ],
  "additionalProperties": false
}

Example:

{
  "id": "084befb6-a264-4dd0-ade9-1aaae390c483",
  "label": "Holdings 1",
  "type": "Whitelist",
  "filterFiles": [
    {
      "label": "Holdings",
      "criteria": "Column: ISSN",
      "filename": "filterFile.txt",
      "fileId": "aa9202b7-754a-414a-8bf6-378df78e5985"
    }
  ],
  "isil": "DE-15"
}

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

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"filter 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/filters/{id}

Delete a filter identified by id

DELETE /finc-config/filters/{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 filter -- constraint violation"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

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

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

Get collections the current filter is assigned to

GET /finc-config/filters/{id}/collections
URI Parameters
  • id: required (string)

Response 200

The collection IDs of collection assigned to this filter

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Finc Select Filter Collections Schema",
  "description": "List of metadata collection IDs assigned to a filter in finc select",
  "type": "object",
  "properties": {
    "id": {
      "description": "ID of associated filter",
      "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}$"
    },
    "collectionIds": {
      "type": "array",
      "id": "collectionIds",
      "description": "List of ids of associated metadata collections",
      "items": {
        "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}$"
      }
    },
    "collectionsCount": {
      "type": "integer",
      "description": "Number of collection ids."
    },
    "isil": {
      "type": "string",
      "description": "Isil of library using this filter"
    }
  },
  "required": [
    "collectionIds"
  ],
  "additionalProperties": false
}

Example:

{
  "id": "6dd325f8-b1d5-4568-a0d7-aecf6b8d6123",
  "collectionIds": [
    "4c890350-4ddf-4851-ae2b-e4403eacca08",
    "4c890350-4ddf-4851-ae2b-e4403eacca09",
    "4c890350-4ddf-4851-ae2b-e4403eacca07"
  ],
  "isil": "DE-15",
  "collectionsCount": 3
}

Response 404

Not found

Body

Media type: text/plain

Type: any

Example:

Not found

Response 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error

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

Add collections to this filter

PUT /finc-config/filters/{id}/collections
URI Parameters
  • id: required (string)
Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Finc Select Filter Collections Schema",
  "description": "List of metadata collection IDs assigned to a filter in finc select",
  "type": "object",
  "properties": {
    "id": {
      "description": "ID of associated filter",
      "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}$"
    },
    "collectionIds": {
      "type": "array",
      "id": "collectionIds",
      "description": "List of ids of associated metadata collections",
      "items": {
        "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}$"
      }
    },
    "collectionsCount": {
      "type": "integer",
      "description": "Number of collection ids."
    },
    "isil": {
      "type": "string",
      "description": "Isil of library using this filter"
    }
  },
  "required": [
    "collectionIds"
  ],
  "additionalProperties": false
}

Response 200

The added collections

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Finc Select Filter Collections Schema",
  "description": "List of metadata collection IDs assigned to a filter in finc select",
  "type": "object",
  "properties": {
    "id": {
      "description": "ID of associated filter",
      "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}$"
    },
    "collectionIds": {
      "type": "array",
      "id": "collectionIds",
      "description": "List of ids of associated metadata collections",
      "items": {
        "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}$"
      }
    },
    "collectionsCount": {
      "type": "integer",
      "description": "Number of collection ids."
    },
    "isil": {
      "type": "string",
      "description": "Isil of library using this filter"
    }
  },
  "required": [
    "collectionIds"
  ],
  "additionalProperties": false
}

Example:

{
  "id": "6dd325f8-b1d5-4568-a0d7-aecf6b8d6123",
  "collectionIds": [
    "4c890350-4ddf-4851-ae2b-e4403eacca08",
    "4c890350-4ddf-4851-ae2b-e4403eacca09",
    "4c890350-4ddf-4851-ae2b-e4403eacca07"
  ],
  "isil": "DE-15",
  "collectionsCount": 3
}

Response 400

Bad request

Body

Media type: text/plain

Type: any

Example:

Bad request

Response 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error