Advanced API

Remove Filter

View as Markdown
GET /equipment/filterwheel/remove-filter

Remove a filter from the list of available filters

Query parameters

  • filterId integer Required

    The filter to remove.

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
  • 409 application/json

    Filter not available

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
  • 500 application/json

    Internal server error, Unknown error

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
GET /equipment/filterwheel/remove-filter 
curl \
 --request GET 'http://localhost:1888/v2/api/equipment/filterwheel/remove-filter?filterId=42'
Response examples (200) 
{
  "Response": "Filter removed",
  "Error": "string",
  "StatusCode": 200,
  "Success": true,
  "Type": "API"
}
Response examples (409) 
{
  "Response": "string",
  "Error": "Filter not available",
  "StatusCode": 409,
  "Success": false,
  "Type": "API"
}
Response examples (500) 
{
  "Response": "string",
  "Error": "Unknown error",
  "StatusCode": 500,
  "Success": false,
  "Type": "API"
}