Inventory Device Serial Headless Operation

The Inventory Device Serial Headless Operation endpoints manageenable automated,programmatic scheduledcontrol of device operations forthrough deviceserial inventorynumber without user interaction.identification. These endpoints allow you to createschedule and monitor background tasks that updateretrieve device statusesoperations like getting parameters, setting configurations, and performmanaging inventoryobjects operationswithout programmatically.manual intervention, making them ideal for automated device management workflows.

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

Authentication: All endpoints require a Bearer token:

Authorization: Bearer <your-api-token>

---

Overview

The Inventory Device Serial Headless Operation API enablesprovides automateda managementpowerful ofinterface for managing device inventory operations thatprogrammatically runusing withoutdevice userserial interface interaction.numbers. This systemAPI category is designed for automated device management scenarios where you need to:to perform bulk operations or scheduled maintenance tasks across multiple devices without manual intervention.

Key Capabilities:

• Schedule automatedDevice Parameter Management: Get and set device configuration parameters using TR-069/CWMP variable paths

Object Operations: Add or delete configuration objects on devices Bulk Operations: Execute the same operation across multiple devices simultaneously Scheduled Transactions: Track and monitor operation status through unique transaction IDs Status Updates: Real-time device status updates using configured helpers

Common Integration Scenarios:

Automated device provisioning and inventoryconfiguration synchronizationmanagement MonitorScheduled long-runningmaintenance inventorytasks operationslike withoutfirmware blockingupdates useror workflowsparameter adjustments IntegrateBulk configuration changes across device managementfleets into automated systemsMonitoring and workflows Perform bulk operationsreporting on device inventoryparameter invalues theRemote backgroundtroubleshooting and diagnostics

TheseThe endpointsAPI workuses togetherTR-069/CWMP data model variable paths (e.g., Device.ManagementServer.PeriodicInformInterval) to provideidentify aspecific completedevice headless operation management system. You can create new scheduled operations using the POST endpointparameters and monitorsupports theirmultiple progressdata usingtypes theincluding GETintegers, endpoint. The operations are designed to handle device serial number tracking, status updates,booleans, and inventory management tasks that may take extended time to complete.

Key concepts include scheduled transactions (operations queuedstrings for execution),set status helpers (automated tools that update device information), and headless processing (operations that run independently of user sessions).operations.

---

Endpoints

GET /inventory_device_serial_headless_operation/

Description: Retrieves information about scheduled deviceheadless inventoryoperations operations.for Thisdevices, endpoint allowsallowing you to monitor theoperation status and progressresults. ofThis backgroundendpoint tasks,supports filtering by transaction ID and can optionally triggeringupdate device status updates before returning results.information.

Use Cases:

• Monitor the progress and results of bulkpreviously scheduled device inventory updates

Check status of scheduled serial number synchronization tasksoperations Retrieve operation logsdetails for auditspecific andtransactions troubleshootingusing purposesthe ID filter TriggerGet updated device status refreshinformation asalong partwith ofoperation monitoringresults workflowsAudit and track device management activities

Full URL Example:

https://control.zequenze.com/api/v1/inventory_device_serial_headless_operation/?id=12345&update_status=true

Parameters:

Parameter	Type	In	Required	Description
id	string	query	No	ID of the specific scheduled transaction to retrieve.filter If omitted, returns all operationsresults
update_status	boolean	query	No	When true, usesUse configured helpers to refreshupdate device status information before returning resultsthe information

cURL Example:

curl -X GET "https://control.zequenze.com/api/v1/inventory_device_serial_headless_operation/?id=12345&update_status=true" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Example Response:

[
  {
    "count"serial_number": 1,"SN123456789",
    "next"operation": null,"get",
    "previous"variables": null,[
      {"variable_name": "results"Device.ManagementServer.PeriodicInformInterval"},
      {"variable_name": "Device.WiFi.SSID.1.SSID"}
    ]
  },
  {
    "serial_number": "SN987654321", 
    "operation": "set",
    "variables": [
      {
        "id"variable_name": "12345"Device.ManagementServer.PeriodicInformInterval",
        "operation_type"value": "bulk_serial_sync"300",
        "status"value_type": "in_progress",
      "progress": 65,
      "total_devices": 150,
      "processed_devices": 98,
      "failed_devices": 2,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T11:45:30Z",
      "estimated_completion": "2024-01-15T12:15:00Z",
      "operation_details": {
        "device_types": ["router", "switch", "access_point"],
        "organization_ids": [101, 102],
        "error_summary": {
          "connection_timeouts": 1,
          "authentication_failures": 1
        }
      }integer"
      }
    ]
  }
]

Response Codes:

Status	Description
200	Success - Returns array of scheduled operation informationoperations
401	Unauthorized - Invalid or missing API token
404	Not Found - SpecifiedNo operationoperations IDfound doesfor notspecified exist

500 Internal Server Error - Operation status update failedcriteria

---

POST /inventory_device_serial_headless_operation/

Description: Creates a new scheduled headless operation for a device inventoryidentified management.by serial number. This endpoint queues background tasks forschedules device serialoperations numberlike synchronization,parameter bulkretrieval, updates,configuration changes, or otherobject inventory operationsmanagement that shouldwill runbe withoutexecuted user interaction.automatically.

Use Cases:

• Schedule bulkconfiguration device serial number synchronizationchanges across multiple organizationsdevices
• CreateRetrieve automatedspecific inventoryparameter auditsvalues thatfor runmonitoring duringor off-hoursreporting
• QueueAdd new configuration objects to devices (e.g., new WiFi SSIDs)

Remove obsolete configuration objects from devices Automate device statusprovisioning updates for large device populations Initiate compliance reporting operations for device inventoryworkflows

Full URL Example:

https://control.zequenze.com/api/v1/inventory_device_serial_headless_operation/

Parameters:Request Body:

The request body Parametershould Type In Required Description data string body Yes JSON string containingcontain operation configurationdetails includingin operationJSON type, target devices, and scheduling parameters format.

cURL Example:Example - Get Operation:

curl -X POST "https://control.zequenze.com/api/v1/inventory_device_serial_headless_operation/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "operation_type"serial_number": "bulk_serial_sync"SN123456789",
    "target_organizations"operation": "get",
    "variables": [101,
      102, 103],{"variable_name": "device_filters": {
      "types": ["router", "switch"],
      "status": ["active", "pending"]
    Device.ManagementServer.PeriodicInformInterval"},
      {"schedule": {
      "execute_at"variable_name": "2024-01-16T02:00:00Z",Device.WiFi.SSID.1.SSID"}
    "priority": "normal"
    },
    "options": {
      "update_firmware_info": true,
      "validate_connectivity": true,
      "timeout_minutes": 120
    }]
  }'

cURL Example - Set Operation:

curl -X POST "https://control.zequenze.com/api/v1/inventory_device_serial_headless_operation/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "serial_number": "SN123456789",
    "operation": "set",
    "variables": [
      {
        "variable_name": "Device.ManagementServer.PeriodicInformInterval",
        "value": "300",
        "value_type": "integer"
      },
      {
        "variable_name": "Device.ManagementServer.PeriodicInformEnable",
        "value": "true",
        "value_type": "boolean"
      }
    ]
  }'

Request Schema:

Field Type Required Description serial_number string Yes Serial number of the target device operation string Yes Operation type: get, set, add.obj, or del.obj variables array No Array of variable objects with operation-specific properties

Variable Object Schema:

For Get/Add Object/Delete Object operations:

Field Type Required Description variable_name string Yes TR-069/CWMP variable path

For Set operations:

Field Type Required Description variable_name string Yes TR-069/CWMP variable path value string Yes Value to set (as string) value_type string Yes Data type: integer, boolean, or string

Example Response:

{
  "id"serial_number": "67890"SN123456789",
  "operation_type"operation": "bulk_serial_sync"set",
  "status"variables": "scheduled",
  "created_at": "2024-01-15T14:30:00Z",
  "scheduled_for": "2024-01-16T02:00:00Z",
  "estimated_duration_minutes": 90,
  "target_device_count": 245,
  "operation_config":[
    {
      "organizations"variable_name": [101, 102, 103]"Device.ManagementServer.PeriodicInformInterval",
      "device_types"value": ["router"300",
      "switch"],value_type": "options": {
      "update_firmware_info": true,
      "validate_connectivity": true,
      "timeout_minutes": 120integer"
    }
  },
  "monitoring_url": "/api/v1/inventory_device_serial_headless_operation/?id=67890"]
}

Response Codes:

Status	Description
201	Created - Operation successfully scheduled
400	Bad Request - Invalid operationrequest configurationdata or malformed JSONparameters
401	Unauthorized - Invalid or missing API token
403404	ForbiddenNot Found - InsufficientDevice permissionswith forspecified targetserial organizations

number not 422 Unprocessable Entity - Valid JSON but invalid operation parametersfound

---

Common Use Cases

Use Case 1: AutomatedBulk NightlyConfiguration Inventory SyncUpdate

Schedule comprehensiveconfiguration changes across multiple devices by creating separate operations for each device inventory synchronization to run during maintenance windows. Create operations that update serial numbers,number. firmwareMonitor versions,progress andusing connectivitythe statusGET acrossendpoint allwith managedtransaction devices without impacting daytime operations.IDs.

Use Case 2: ComplianceDevice AuditHealth PreparationMonitoring

GenerateRegularly scheduledretrieve key device parameters like uptime, signal strength, and error counters by scheduling get operations thatfor collectspecific variables across your device serial numbers and configuration data needed for compliance reporting. Monitor progress through the GET endpoint and retrieve results when auditors require current inventory information.fleet.

Use Case 3: LargeAutomated Organization Device ManagementProvisioning

ForSet organizationsup managingnew hundredsdevices orby thousandsscheduling a series of devices, create bulkset operations thatto updateconfigure network settings, management parameters, and service configurations based on device informationserial across multiple sites and device types. Use the monitoring capabilities to track progress and handle any devices that fail to update.numbers.

Use Case 4: IntegrationWiFi withNetwork External SystemsManagement

IntegrateAdd devicenew inventoryWiFi updatesSSIDs withto externaldevices assetusing management,add.obj ticketing,operations, or monitoringremove systemsobsolete bynetworks schedulingusing operationsdel.obj throughoperations, thetargeting APIspecific andTR-069 monitoringWiFi theirobject completion status programmatically.paths.

Use Case 5: ProactiveCompliance Device MaintenanceReporting

Schedule regular get operations thatto checkretrieve device connectivitysecurity and updateconfiguration statusparameters information,needed enablingfor proactivecompliance identificationreporting, ofusing devicesthe thatupdate_status mayflag needto attentionensure beforecurrent they impact network operations.data.

---

Best Practices

• ScheduleTransaction Tracking: Always store the transaction IDs returned from POST operations during low-usage periods to minimizemonitor impact on network performancestatus and device availability

Use appropriate timeout values in operation configuration to balance thoroughness with completion time Monitor operation progress regularlyresults using the GET endpoint, especially for large-scale operations affecting many devicesendpoint Error Handling: Implement properretry error handlinglogic for failed operations and retrycheck logicdevice forconnectivity transientbefore networkscheduling issuescritical configuration changes FilterBatch targetProcessing: devicesWhen appropriatelyupdating tomultiple avoiddevices, unnecessaryimplement operations on devices that don't require updates Considerproper rate limiting when creating multiple operations to avoid overwhelming the schedulingAPI systemor target devices StoreVariable operationPath IDsValidation: returnedVerify fromTR-069/CWMP POSTvariable requestspaths are correct for lateryour monitoringdevice andmodels resultbefore retrievalscheduling operations Data Type Consistency: Ensure value_type matches the actual parameter type expected by the device (integer, boolean, string) Status Updates: Use the update_status parameter judiciously as it may impactadd responselatency timesto GET requests but ensures current device information Security: Never include sensitive credentials or keys in variable values; use secure provisioning methods for operationsauthentication involving many devicesparameters

---