Filters for Finc Config API documentation

Finc config filters

Collection of filter items.

/finc-config/filters get post

get

Get all filters

post

Post new filter

Get all filters

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

((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]

HTTP status code 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",
        "$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
      }
    },
    "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
}

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

Post new filter

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": "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",
        "$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
}

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

HTTP status code 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"
}

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 filter -- 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 filters -- unauthorized

HTTP status code 422

Validation errors

Body

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"
        }
      ]
    }
  ]
}

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-config/filters/{id} get put delete

Entity representing a filter

get

Get one finc select filter identified by id

put

Put a filter identified by id

delete

Delete a filter identified by id

Get one finc select filter 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": "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",
        "$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
}

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

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

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

Put a filter 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]

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

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

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

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"filter 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 a filter 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 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 filter -- constraint violation"

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"filter 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-config/filters/{id}/collections get put

get

Get collections the current filter is assigned to

put

Add collections to this filter

Get collections the current filter is assigned to

Request
Response

URI Parameters

id: required(string)

HTTP status code 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
}

HTTP status code 404

Not found

Body

Media type: text/plain

Type: any

Example:

Not found

HTTP status code 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error

Add collections to this filter

Request
Response

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
}

HTTP status code 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
}

HTTP status code 400

Bad request

Body

Media type: text/plain

Type: any

Example:

Bad request

HTTP status code 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error

Filters for Finc Config API documentation version v1

mod-finc-config API

Finc config filters

Filters for Finc Config API documentation version v1

mod-finc-config API

Finc config filters

/finc-config/filters get post

get /finc-config/filters

Query Parameters

HTTP status code 200

Body

HTTP status code 400

Body

HTTP status code 401

Body

HTTP status code 500

Body

post /finc-config/filters

Query Parameters

Body

HTTP status code 201

Headers

Body

HTTP status code 400

Body

HTTP status code 401

Body

HTTP status code 422

Body

HTTP status code 500

Body

/finc-config/filters/{id} get put delete

get /finc-config/filters/{id}

URI Parameters

Query Parameters

HTTP status code 200

Body

HTTP status code 404

Body

HTTP status code 500

Body

put /finc-config/filters/{id}

URI Parameters

Query Parameters

Body

HTTP status code 204

HTTP status code 400

Body

HTTP status code 404

Body

HTTP status code 500

Body

delete /finc-config/filters/{id}

URI Parameters

Query Parameters

HTTP status code 204

HTTP status code 400

Body

HTTP status code 404

Body

HTTP status code 500

Body

/finc-config/filters/{id}/collections get put

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

URI Parameters

HTTP status code 200

Body

HTTP status code 404

Body

HTTP status code 500

Body

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

URI Parameters

Body

HTTP status code 200

Body

HTTP status code 400

Body

HTTP status code 500

Body