Inventory Parameter

Endpoints Summary

Method Path Swagger GET /inventory_parameter/ Swagger ↗ GET /inventory_parameter/{id}/ Swagger ↗

---

The Inventory Parameter API endpoints provide access to parameter definitions that control how device attributes are collected, displayed, and managed within the Zequenze Control platform. These endpoints allow you to retrieve and manage parameter definitionsconfigurations thatincluding describetheir thedata configurabletypes, validation rules, and monitorablegrouping attributes of devices in your inventory. These endpoints are essential for understanding what parameters are available for device configuration, monitoring, and data collection across your managed infrastructure.information.

Base URL: https://control.zequenze.com/api/v1

Authentication: All endpoints require a Bearer token:

Authorization: Bearer <your-api-token>

---

Overview

The Inventory Parameter API providescategory accessmanages tothe parameter definitions thatused servethroughout asthe templatesZequenze Control platform for device configurationmanagement and monitoring. These parametersParameters define the structure and behavior of data fields that can be appliedcollected tofrom devicesmanaged devices, displayed in yourthe inventoryuser system.interface, and used for device configuration.

Each inventory parameter includes essentialcontains metadata such as:

as

Parameter identification (name, variable name, short name) Datadata type specification (string, integer, boolean, select, etc.), validation requirements, display properties, and grouping information. Parameters can be configured as metrics to enable historical data collection, marked as read-only for displaying device-reported information, or set as required fields for configuration validation.

These endpoints are essential for:

Understanding the structure of device data collection Building Behavioralcustom flagsinterfaces (required,that read-only,work metricwith tracking)the platform's parameter system Automating Groupparameter associationdiscovery forand logicalmanagement organizationworkflows Integrating Positionwith orderingthe forplatform's consistentdevice UImanagement presentationcapabilities

Key Concepts:

Parameter Types: Determine how data is displayed and validated (string, integer, boolean, select, etc.) Metric Parameters: When enabled, the system stores historical data for trend analysis Read-only Parameters: Used for storing data captured from devices, not for configuration Parameter Groups: Logical collections thatgroups organize related parameters together and Discoverycan Groups:be Specialassociated groupswith containingspecific parametersservices automaticallyor discovereddiscovery byprocesses. theThe systemAPI supports

Common Integration Scenarios:

Building dynamic configuration forms based on available parameters Retrieving parameter definitions before creating device configurations Understanding which parameters support historical tracking for monitoring dashboards Filteringfiltering parameters by group toand organizeprovides configurationdetailed workflowsinformation about parameter properties and their relationships.

---

Endpoints

GET /inventory_parameter/

Description: Retrieves a paginated list of all inventory parameterparameters definitions.in the system. This endpoint is typically used to build dynamic configuration interfaces, understand available parameter types, or syncreturns parameter definitions including their data types, validation rules, grouping, and configuration properties. Use this endpoint to discover available parameters, understand their structure, or build custom interfaces that work with externalthe systems.platform's parameter system.

Use Cases:

• Building dynamiccustom device configurationmanagement formsinterfaces inthat aneed webto application

Synchronizingdisplay parameter definitions withDiscovering externalavailable configurationparameters managementfor systemsa specific service or parameter group Auditing availableparameter parametersconfigurations across differentthe device groupsplatform Creating automated workflows that work with parameter selection interfaces for reporting toolsmetadata

Full URL Example:

https://control.zequenze.com/api/v1/inventory_parameter/?group=515&limit=50&offset=0

Parameters:

Parameter	Type	In	Required	Description
group	integer	query	No	Filter parameters by group ID to retrieve only parameters belonging to a specific parameter group
limit	integer	query	No	Number of results to return per page (default pagination applies if not specified)
offset	integer	query	No	The initial index from which to return results for pagination

cURL Example:

curl -X GET "https://control.zequenze.com/api/v1/inventory_parameter/?group=515&limit=20&offset=0" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Example Response:

{
  "count": 45,87,
  "next": "https://control.zequenze.com/api/v1/inventory_parameter/?group=515&limit=20&offset=20",
  "previous": null,
  "results": [
    {
      "id": 12,42,
      "name": "Device Hostname"Serial Number",
      "short_name": "hostname"device-serial",
      "variable_name": "device_hostname"device_serial_number",
      "type": "string",
      "position": 1,
      "required": true,
      "read_only": false,true,
      "metric": false,
      "group": {
        "id": 5,15,
        "name": "NetworkDevice Configuration"Information",
        "service": "network-device-mgmt",
        "discovery_group": false,
        "title": "NetworkBasic Settings"Device Information"
      }
    },
    {
      "id": 13,43,
      "name": "DHCPFirmware Enabled"Version",
      "short_name": "dhcp-enabled"firmware-version",
      "variable_name": "dhcp_enabled"firmware_version",
      "type": "boolean"readonly",
      "position": 2,
      "required": false,
      "read_only": false,
      "metric": true,
      "group": {
        "id": 5,
        "name": "Network Configuration",
        "service": "network-mgmt",
        "discovery_group": false,
        "title": "Network Settings"
      }
    },
    {
      "id": 14,
      "name": "CPU Usage",
      "short_name": "cpu-usage",
      "variable_name": "cpu_usage_percent",
      "type": "decimal",
      "position": 3,
      "required": false,
      "read_only": true,
      "metric": true,
      "group": {
        "id": 5,15,
        "name": "NetworkDevice Configuration"Information",
        "service": "network-device-mgmt",
        "discovery_group": false,
        "title": "NetworkBasic Settings"Device Information"
      }
    },
    {
      "id": 44,
      "name": "Device Status",
      "short_name": "device-status",
      "variable_name": "device_status",
      "type": "select",
      "position": 3,
      "required": true,
      "read_only": false,
      "metric": true,
      "group": {
        "id": 15,
        "name": "Device Information",
        "service": "device-mgmt",
        "discovery_group": false,
        "title": "Basic Device Information"
      }
    }
  ]
}

Response Codes:

Status	Description
200	Success - Returns paginated list of inventory parameters
400

Bad Request - Invalid query parameters 401 Unauthorized - Invalid or missing authentication token 403400 ForbiddenBad Request - InsufficientInvalid permissions to access inventoryquery parameters

---

GET /inventory_parameter/{id}/

Description: Retrieves detailed information about a specific inventory parameter by its unique ID. This endpoint provides complete parameter definition including all metadata,properties, typevalidation information,rules, and group associationsinformation. neededUse this endpoint when you need full details about a specific parameter for implementation.configuration or display purposes.

Use Cases:

• RetrievingGetting detailedcomplete details about a parameter specifications before creatingusing it in device configurationsconfiguration

Retrieving parameter metadata for building dynamic forms or interfaces Understanding the full configuration of a specific parameter including its group relationships Validating parameter constraintsproperties andbefore typesmaking duringconfiguration form validation Understanding parameter relationships and group associations Implementing parameter-specific UI components based on type and flagschanges

Full URL Example:

https://control.zequenze.com/api/v1/inventory_parameter/12/?group=542/

Parameters:

Parameter	Type	In	Required	Description
id	integer	path	Yes	The unique identifier of the inventory parameter to retrieve
group	integer	query	No	FilterAdditional filter by group ID -(optional usefulconstraint for validation when working within specific parameter groupsvalidation)

cURL Example:

curl -X GET "https://control.zequenze.com/api/v1/inventory_parameter/12/42/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Example Response:

{
  "id": 12,42,
  "name": "Device Hostname"Serial Number",
  "short_name": "hostname"device-serial",
  "variable_name": "device_hostname"device_serial_number",
  "type": "string",
  "position": 1,
  "required": true,
  "read_only": false,true,
  "metric": false,
  "group": {
    "id": 5,15,
    "name": "NetworkDevice Configuration"Information",
    "service": "network-device-mgmt",
    "discovery_group": false,
    "title": "NetworkBasic Settings"Device Information"
  }
}

Response Codes:

Status	Description
200	Success - Returns the requestedspecified inventory parameter details
401	Unauthorized - Invalid or missing authentication token

403 Forbidden - Insufficient permissions to access this parameter 404 Not Found - Parameter with specified ID does not exist 400 Bad Request - Invalid parameter ID format

---

Common Use Cases

Use Case 1: Building Dynamic Device Configuration Forms

RetrieveWhen creating custom interfaces for device management, use the list endpoint to retrieve all parameters for a specific groupgroup, then use their type and validation properties to dynamicallybuild generateappropriate deviceform configuration forms with proper field types, validation rules, and required field indicators.controls.

# Get all parameters for network configuration group
curl -X GET "https://control.zequenze.com/api/v1/inventory_parameter/?group=5" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Use Case 2: Parameter ValidationDiscovery Beforefor DeviceNew UpdatesServices

BeforeWhen updatingintegrating devicea configurations,new service, filter parameters by discovery groups to identify automatically discovered parameters, then retrieve specifictheir parameterfull details to validateunderstand what data types,is requiredbeing fields, and read-only restrictions.collected.

# Validate parameter constraints before configuration update
curl -X GET "https://control.zequenze.com/api/v1/inventory_parameter/12/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Use Case 3: MonitoringMetric DashboardParameter SetupIdentification

IdentifyQuery parameters markedwhere asmetric: metricstrue to buildidentify which device attributes are being tracked historically, useful for building monitoring dashboards andor historicalanalytics trend analysis interfaces.features.

# Filter and identify metric parameters for dashboard creation
curl -X GET "https://control.zequenze.com/api/v1/inventory_parameter/?limit=100" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Use Case 4: ConfigurationValidation TemplateRule CreationImplementation

Retrieve parameter definitionsdetails to createunderstand reusablevalidation requirements (required, read_only, type) when implementing custom device configuration templates that can be applied across multiple devices of the same type.workflows.

Use Case 5: Discovery Parameter ManagementGroup Analysis

IdentifyUse parametersthe ingroup discoveryfilter groupsto thatanalyze containparameter automaticallyorganization detectedand understand how different device information,attributes whichare cancategorized bewithin promotedthe to regular configuration groups.platform.

---

Best Practices

• Use GroupPagination FilteringEffectively: When buildingretrieving configurationlarge interfaces,parameter filterlists, parametersuse byappropriate grouplimit values (20-100) to organizebalance relatedperformance settingswith anddata improve user experienceneeds
• RespectFilter Parameterby TypesGroup: AlwaysUse validatethe inputgroup parameter to narrow results to relevant parameter sets, improving performance and reducing data according to the parameter's type field before submitting configuration changes

Handle Read-Only Parameters: Parameters with read_only: true should be displayed for information only and excluded from configuration forms Implement Metric Tracking: Parameters with metric: true are suitable for historical data collection and trend monitoringtransfer Cache Parameter Definitions: Parameter definitions change infrequently, makingso themcache excellent candidates for client-side cachingresults to improve application performance PaginationValidate Strategy:Parameter Use appropriate limit values (20-100) when retrieving large parameter sets to balance performance and usability Required Field ValidationTypes: Always check the requiredtype field to ensure proper data handling - the platform supports 24 different parameter types with specific validation rules Handle Read-Only Parameters: Respect the read_only flag when building formsinterfaces to- ensurethese properparameters validationshould beforeonly submissiondisplay data, not accept input Position-BasedMonitor OrderingMetric Parameters: UseParameters thewith positionmetric: true fieldprovide historical data - use these for building monitoring and analytics features Group Relationships: Pay attention to maintaingroup consistentinformation as it provides context about parameter orderingorganization acrossand differentservice interfacesassociations

---