> ## Documentation Index > Fetch the complete documentation index at: https://support.keypro.fi/llms.txt > Use this file to discover all available pages before exploring further. # Get list of AquaFireplugType > Operation is used to get a list of AquaFireplugType. AquaFireplugType data can be filtered by giving filtering parameters at HTTP querystring (see parameters). ## OpenAPI ````json GET /aqua-fireplug-types/ { "openapi": "3.0.4", "info": { "title": "Keyduct REST API", "termsOfService": "https://www.keypro.fi/en/terms-of-service", "contact": { "name": "Keypro Oy", "url": "https://keypro.fi/", "email": "keypro@keypro.fi" }, "license": { "name": "Copyright (C) Keypro Oy. All rights reserved.", "url": "https://www.keypro.fi/" }, "version": "2.0.0" }, "servers": [ { "url": "/api/v2" } ], "tags": [ { "name": "Task", "description": "Task related operations." }, { "name": "Subregion", "description": "Subregion related operations." }, { "name": "SAttribute", "description": "SAttribute related operations." }, { "name": "Fault", "description": "Fault related operations." }, { "name": "Maintenance history", "description": "Maintenance history related operations." }, { "name": "Deflection", "description": "Deflection related operations." }, { "name": "Fault Component", "description": "Fault Component related operations." }, { "name": "Task Comment", "description": "Task comment related operations." }, { "name": "FaultComponentFault", "description": "FaultComponentFault related operations." }, { "name": "Collections", "description": "Collection related operations." }, { "name": "Contact Person", "description": "ContactPerson related operations" }, { "name": "Contact Person Connection", "description": "ContactPersonConnection related operations" }, { "name": "Plan", "description": "Plan related operations." }, { "name": "FreeArea", "description": "FreeArea related operations." }, { "name": "Address", "description": "Building address related operations." }, { "name": "Apartment", "description": "Building apartments related operations." }, { "name": "Customer", "description": "Customer data related operations." }, { "name": "Customer Contract", "description": "Customer contract related operations." }, { "name": "Extra Attribute", "description": "Extra attributes related operations." }, { "name": "Extra Value", "description": "Extra attribute values related operations." }, { "name": "Consumer Point", "description": "Consumer point related operations." }, { "name": "Consumer Point Linked Address", "description": "Consumer point address link related operations." }, { "name": "Flow Meter", "description": "Flow Meter related operations." }, { "name": "Text Constant", "description": "Text Constant related operations." }, { "name": "Sn Constant", "description": "Sn Constant related operations." }, { "name": "Gas Meter", "description": "Gas Meter related operations." }, { "name": "Junction", "description": "Junction related operations." }, { "name": "Junction Connection", "description": "Junction Connection related operations." }, { "name": "External Document", "description": "External documents related operations." }, { "name": "Water Duct Renovation", "description": "Water duct renovation related operations." }, { "name": "Sewer Duct Renovation", "description": "Sewer duct renovation related operations." }, { "name": "Water Duct", "description": "Water duct related operations." }, { "name": "Water Other Node", "description": "Water other node related operations." }, { "name": "Water Hydrant", "description": "Water hydrant related operations." }, { "name": "Water Branch", "description": "Water branch related operations." }, { "name": "Water Measuring Point", "description": "Water measuring point related operations." }, { "name": "Fire Water Station", "description": "Fire water station related operations." }, { "name": "Water Fireplug", "description": "Water fireplug related operations." }, { "name": "Sewer Duct", "description": "Sewer duct related operations." }, { "name": "Flow Meter Reading", "description": "Flow Meter Reading related operations." }, { "name": "Gas Meter Reading", "description": "Gas meter reading related operations." }, { "name": "Gas Cable", "description": "Gas cable related operations." }, { "name": "Gas Other Node", "description": "Gas other node related operations." }, { "name": "Gas Valve", "description": "Gas valve related operations." }, { "name": "Water Node", "description": "Water node related operations." }, { "name": "Consumer Point Property", "description": "Consumer point property related operations." }, { "name": "Dh Manhole", "description": "Dh manhole related operations." }, { "name": "Dh Manhole Link Connection", "description": "Dh Manhole Link Connection related operations." }, { "name": "Dh Cable", "description": "Dh cable related operations." }, { "name": "Error Report", "description": "Error report related operations." }, { "name": "Failure Report", "description": "Failure report related operations." }, { "name": "DCCTV Comparison", "description": "DCCTV comparison (nearest object lookup + manual pick) related operations." }, { "name": "TV Inspection", "description": "CCTV TV inspection related operations." }, { "name": "Manhole Inspection", "description": "Manhole inspection related operations." }, { "name": "Dh Duct", "description": "Dh duct related operations." }, { "name": "Dh Conduit", "description": "Dh conduit related operations." }, { "name": "Dh Division", "description": "Dh division related operations." }, { "name": "Dh Valve", "description": "Dh valve related operations." }, { "name": "Consumer Point User", "description": "Consumer Point User related operations." }, { "name": "Consumer Point Real Estate", "description": "Consumer point real estate related operations." }, { "name": "Consumer Point User Email", "description": "Consumer point user email related operations." }, { "name": "Water Pumping Station", "description": "Water pumping station related operations." }, { "name": "Dh Meter Reading", "description": "Dh Meter Reading related operations." }, { "name": "Consumer Point Connection", "description": "Consumer point connection related operations." }, { "name": "Modeling Data", "description": "Modeling data related operations.\n\n*NOTE:* Contrary to what is described in chapter 1.5, the base path for all of these operations is `/keyaqua_modeling`\n" }, { "name": "Gas Manhole", "description": "Gas manhole related operations." }, { "name": "KeyDh Observation", "description": "KeyDh Observation related operations." }, { "name": "KeyDh Supply Interruption", "description": "KeyDh Supply Interruption related operations." }, { "name": "KeyDh Supply Interruption Connection", "description": "KeyDh Supply Interruption Connection related operations." }, { "name": "Keydh Node", "description": "Keydh Node related operations." }, { "name": "Keygas Duct", "description": "Keygas Duct related operations." }, { "name": "Real Estate", "description": "Real Estate related operations." }, { "name": "Keydh Connection", "description": "Keydh Connection related operations." }, { "name": "Water Tank", "description": "Water Tank related operations." }, { "name": "Water Valve", "description": "Water Valve related operations." }, { "name": "Point", "description": "Point related operations." }, { "name": "Sn Modeling", "description": "Sn Modeling related operations." }, { "name": "Sewer Manholes v2", "description": "Sewer Manholes v2 related operations." }, { "name": "Sewer Ducts", "description": "Sewer Ducts related operations." }, { "name": "Sewer Valves", "description": "Sewer Valves related operations." }, { "name": "Sewer Pumping Stations", "description": "Sewer Pumping Stations related operations." }, { "name": "Sewer Branches", "description": "Sewer Branches related operations." }, { "name": "Sewer Measuring Poins", "description": "Sewer Measuring Poins related operations." }, { "name": "Sewer Other Nodes", "description": "Sewer Other Nodes related operations." }, { "name": "Keydh Conduit Link", "description": "Keydh Conduit Link related operations." }, { "name": "Duct Condition Detail", "description": "Duct condition detail related operations." }, { "name": "KeyDh Conduit Error", "description": "KeyDh Conduit Error related operations." }, { "name": "AquaObjectType", "description": "AquaObjectType related operations." }, { "name": "AquaMeasuringPointTypes", "description": "AquaMeasuringPointTypes related operations." }, { "name": "AquaPumpType", "description": "AquaPumpType related operations." }, { "name": "AquaBranchType", "description": "AquaBranchType related operations." }, { "name": "AquaValveType", "description": "AquaValveType related operations." }, { "name": "AquaManholeType", "description": "AquaManholeType related operations." }, { "name": "AquaDuctType", "description": "AquaDuctType related operations." }, { "name": "SnDuctType", "description": "SnDuctType related operations." }, { "name": "SnManholeType", "description": "SnManholeType related operations." }, { "name": "SnLidType", "description": "SnLidType related operations." }, { "name": "Sewer Nodes", "description": "Sewer Node related operations." }, { "name": "Sn Control", "description": "Sn Control related operations." }, { "name": "KeyDh Shell Type", "description": "KeyDh Shell Type related operations." }, { "name": "Sewer Branch Type", "description": "Sewer Branch Type related operations." }, { "name": "Sewer Valve Type", "description": "Sewer Valve Type related operations." } ], "paths": { "/aqua-fireplug-types/": { "get": { "tags": [ "AquaFireplugType" ], "summary": "Get list of AquaFireplugType", "description": "Operation is used to get a list of AquaFireplugType.\n\nAquaFireplugType data can be filtered by giving filtering parameters at HTTP querystring (see parameters).\n", "operationId": "getAquaFireplugType", "parameters": [ { "$ref": "#/components/parameters/offsetParam" }, { "$ref": "#/components/parameters/limitParam" }, { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderParam" } ], "responses": { "200": { "description": "A result response object", "content": { "application/json": { "schema": { "type": "object", "properties": { "Next": { "type": "string", "description": "Url to next page of the list if applicable. (Null if none)", "format": "url" }, "Previous": { "type": "string", "description": "Url to previous page of the list if applicable. (Null if none)", "format": "url" }, "Results": { "type": "array", "items": { "$ref": "#/components/schemas/AquaFireplugType" }, "description": "List of fetched AquaFireplugType" }, "Total": { "type": "integer", "description": "Total number of AquaFireplugType objects in the list" } } } } } }, "401": { "$ref": "#/components/responses/Http401" } }, "security": [ { "Token": [] } ] } } }, "components": { "parameters": { "offsetParam": { "name": "offset", "in": "query", "description": "Offset to start returning results.", "schema": { "minimum": 0, "type": "integer" } }, "limitParam": { "name": "limit", "in": "query", "description": "Limit number of results returned. Set to -1 to use maximum limit set in the environment. Default limit will be used if parameter is not specified. Special value -1 is available from product version 3.2.18.", "schema": { "minimum": 1, "type": "integer" } }, "filterParam": { "name": "__any of the object fields__", "in": "query", "description": "Filters list by selected object field value.\nSupports structured queries via +++__+++ delimiter.\nSupports ending keywords via +++__+++ delimiter:\n- For string fields: istartswith, startswith, iendswith, endswith, contains, icontains, isnull\n- For numerics: gt, lt, gte, lte, isnull\n- For spatial fields: contains, isnull, within, intersects, disjoint, touches, overlaps, covers, coveredby\n**Examples:** `+++usage_state__txt__istartswith=in+++` ,\n`+++plan__state__txt__startswith=In+++` , `+++creation_date__gte=2019-01-02T15:32:01+++`,\n`+++location__within=POLYGON ((641503.89 6944059.81, 641406.52 6943933.87, 641369.48 6943772.48, 641474.25 6943704.74, 641873.78 6943735.96, 641848.38 6943975.15, 641607.08 6944167.76, 641653.11 6944102.15, 641503.89 6944059.81))+++`\nSupports exclusive queries by field value using a not-operator preceding the field lookup:\n**Examples:** `+++not__type__txt__istartswith=Tie+++` , `+++not__id=1390+++`\n", "schema": { "type": "string" } }, "orderParam": { "name": "orderby", "in": "query", "description": "Selects the object field to order the returned objects by.\nCan be used to sort in reverse order with '-' prefix.\nCan have several ordering rules separated by comma.\nCan be used only for object own fields and does not support structured queries.\n**Example:** `orderby=creator,-creation_date`\n", "schema": { "type": "string" } } }, "schemas": { "AquaFireplugType": { "type": "object", "properties": { "feature": { "type": "string", "description": "Aqua fireplug type feature" }, "fireplyg_type": { "$ref": "#/components/schemas/SnConstants" }, "id": { "type": "integer", "description": "Primary key", "readOnly": true } } }, "SnConstants": { "required": [ "groupname" ], "type": "object", "properties": { "groupname": { "type": "string", "description": "Group name of constant. Group name must contain only uppercase letters separated by underscores." }, "id": { "type": "integer", "description": "Primary key", "readOnly": true }, "num_value": { "type": "integer", "description": "Numerical value of the constant" }, "orderno": { "type": "integer", "description": "Order number" }, "txt": { "type": "string", "description": "Human readable textual representation" }, "txt_2": { "type": "string", "description": "Human readable textual representation" }, "value": { "type": "string", "description": "Logical textual value" } } }, "ErrorDetailsResponse": { "required": [ "details" ], "type": "object", "properties": { "details": { "type": "string", "description": "Detailed description of error" } }, "description": "Standard error response payload" } }, "responses": { "Http401": { "description": "Authentication credentials are missing or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDetailsResponse" }, "example": { "details": "Authentication credentials were not provided" } } } } }, "securitySchemes": { "Token": { "type": "apiKey", "description": "Token issued for API consumer.", "name": "Authorization", "in": "header" } } } } ````