Inventory Device Serial Operation

The Inventory Device Serial Operation APIendpoints providesenable functionality to update device information using serial numbers as identifiers. This endpoint is designed for bulkremote device management operationsby whereallowing you needto perform critical operations on devices identified by their serial numbers. This API provides a streamlined way to modifyexecute common device attributesmaintenance ortasks settingssuch directlyas byreboots, serialfactory number,resets, makingconfiguration it ideal for inventory management systemssynchronization, and devicereconfiguration provisioningwithout workflows.physical access to the devices.

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 Operation API category contains endpoints specifically designed forprovides device management operationscapabilities thatfor targetremotely controlling devices byin theiryour uniqueinventory serial numbers.system. This approachAPI is particularlyessential usefulfor whenIT integratingadministrators, withdevice externalmanagers, and automated systems that primarilyneed identifyto perform maintenance operations on deployed devices byacross different locations.

Key Features:

Execute device operations using serial numbers ratheras thanunique internalidentifiers databaseSupport IDs.for multiple operation types including reboots, factory resets, and configuration management Designed for both manual administrative tasks and automated device lifecycle management Real-time operation execution with immediate response feedback

Common Scenarios:

Remote Troubleshooting: Restart unresponsive devices without physical access Device Provisioning: Factory reset devices for redeployment or initial setup Configuration Management: Sync device configurations or trigger reconfiguration after policy changes Maintenance Workflows: Integrate device operations into automated maintenance schedules

This API category is commonlyparticularly usedvaluable infor scenariosorganizations where:

managing

large Externalfleets inventoryof managementdevices systemsacross needmultiple tolocations, syncwhere devicephysical dataaccess Bulkfor devicemaintenance configurationoperations updateswould arebe required Device provisioning workflows need to update device statusimpractical or attributes Asset management systems need to modify device properties

The serial number-based approach eliminates the need to first query for device IDs, streamlining operations where serial numbers are the primary identifier. This is especially valuable in enterprise environments where serial numbers are used for device tracking and management.costly.

---

Endpoints

PUT /inventory_device_serial_operation/{serial_number}/

Description: Updates device information and configuration forExecutes a specificspecified operation on a device identified by its serial number. This endpoint allowssupports you to modifyvarious device attributes,management status,operations including reboots, factory resets, configuration settings,synchronization, and otherreconfiguration. propertiesThe withoutoperation needingis toexecuted knowimmediately theupon internalsuccessful devicerequest ID. It's designed for bulk operations and integration with external systems that use serial numbers as primary identifiers.processing.

Use Cases:

• UpdatingRemotely restart a device statusthat duringhas deploymentbecome unresponsive or decommissioningis processesexperiencing connectivity issues
• ModifyingPerform factory reset on devices being reassigned to different users or locations

Synchronize device configuration after updating policies or settings duringin provisioningthe management system SyncingTrigger device informationreconfiguration fromwhen externalnetwork assetparameters managementor systemssecurity settings change Bulk updatingReset device attributessettings duringwhile inventorypreserving reconciliation Settingcore device location,firmware assignment,(device orfactory organizational unit informationreset)

Full URL Example:

https://control.zequenze.com/api/v1/inventory_device_serial_operation/ABC123456789/

Parameters:

Parameter	Type	In	Required	Description
serial_number	string	path	Yes	The unique serial number of the device to updateoperate on
data	string	body	Yes	JSON stringpayload containing the device propertiesoperation to updateperform

Request Body Schema:

Field Type Required Description Allowed Values operation string Yes The operation to perform on the device reboot, factory, device_factory, sync, reconf

Operation Types:

reboot - Restart the device factory - Perform complete factory reset (all settings and data) device_factory - Perform device factory reset (preserves some core settings) sync - Synchronize device configuration with management server reconf - Trigger device reconfiguration process

cURL Example:

curl -X PUT "https://control.zequenze.com/api/v1/inventory_device_serial_operation/ABC123456789/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name"operation": "Conference Room Laptop",
    "status": "active",
    "location": "Building A - Room 101",
    "assigned_user": "john.doe@company.com",
    "organization_unit": "IT Department",
    "configuration": {
      "auto_update": true,
      "backup_enabled": true,
      "encryption_status": "enabled"
    },
    "tags": ["laptop", "conference-room", "windows"]reboot"
  }'

Example Request Body:

{
  "name"operation": "Conference Room Laptop",
  "status": "active",
  "location": "Building A - Room 101",
  "assigned_user": "john.doe@company.com",
  "organization_unit": "IT Department",
  "device_type": "laptop",
  "manufacturer": "Dell",
  "model": "Latitude 5520",
  "configuration": {
    "auto_update": true,
    "backup_enabled": true,
    "encryption_status": "enabled",
    "compliance_profile": "corporate-standard"
  },
  "custom_fields": {
    "purchase_date": "2024-01-15",
    "warranty_expiry": "2027-01-15",
    "cost_center": "IT-001"
  },
  "tags": ["laptop", "conference-room", "windows"]reboot"
}

Example Response:

{
  "id": 1247,12345,
  "serial_number"operation": "ABC123456789",
  "name": "Conference Room Laptop",
  "status": "active",
  "location": "Building A - Room 101",
  "assigned_user": "john.doe@company.com",
  "organization_unit": "IT Department",
  "device_type": "laptop",
  "manufacturer": "Dell",
  "model": "Latitude 5520",
  "configuration": {
    "auto_update": true,
    "backup_enabled": true,
    "encryption_status": "enabled",
    "compliance_profile": "corporate-standard"
  },
  "custom_fields": {
    "purchase_date": "2024-01-15",
    "warranty_expiry": "2027-01-15",
    "cost_center": "IT-001"
  },
  "tags": ["laptop", "conference-room", "windows"],
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-03-15T14:22:33Z",
  "last_seen": "2024-03-15T14:20:15Z"reboot"
}

Response Fields:

Field Type Description id integer Unique identifier for the operation request (read-only) operation string Confirmation of the operation that was executed

Response Codes:

Status	Description
200	Success - DeviceOperation updatedinitiated successfully with the new information
400	Bad Request - Invalid dataoperation formattype or missingmalformed required fieldsrequest
401	Unauthorized - Invalid or missing APIauthentication token
404	Not Found - Device with the specified serial number does not existfound
422	Unprocessable Entity - Valid JSONrequest format but invalidoperation datacannot valuesbe processed
500	Internal Server Error - Server-sideServer error during processingoperation execution

---

Common Use Cases

Use Case 1: Remote Device Deployment AutomationTroubleshooting

When deployingdevices devicesbecome unresponsive or experience connectivity issues, use the reboot operation to endrestart users,them update device status, assigned user, and location information using the device's serial number.remotely. This is typicallyparticularly integrateduseful intofor devicedevices provisioningdeployed workflowsin remote locations where thephysical serial numberaccess is scanneddifficult or enteredcostly.

during

Endpoints: thePUT deployment/inventory_device_serial_operation/{serial_number}/ process.with operation: "reboot"

Use Case 2: AssetDevice ManagementReassignment Integrationand Redeployment

SyncBefore devicereassigning informationdevices fromto externalnew assetusers managementor systemslocations, thatperform usea serialfactory numbersreset asto primaryensure identifiers.all Updateprevious deviceuser location, cost center, warranty information,data and otherconfigurations asset-relatedare propertiesremoved. withoutThis needingmaintains tosecurity mapand toprovides internala IDs.clean slate for new deployments.

Endpoints: PUT /inventory_device_serial_operation/{serial_number}/ with operation: "factory"

Use Case 3: Bulk Configuration UpdatesManagement Workflows

ApplyAfter updating device policies, security settings, or network configurations in your management system, trigger configuration changessynchronization to multipleensure all devices byreceive serialthe numberlatest duringsettings compliancewithout updatesmanual orintervention.

security

Endpoints: policyPUT changes./inventory_device_serial_operation/{serial_number}/ Thiswith allowsoperation: for batch processing where each device is identified by its unique serial number."sync"

Use Case 4: InventoryAutomated ReconciliationMaintenance Schedules

UpdateIntegrate device informationoperations into automated maintenance workflows that can perform regular reboots during physicaloff-hours, inventorysync auditsconfigurations whereafter policy updates, or prepare devices arefor identifiedredeployment byas theirpart serialof numbers.lifecycle Correctmanagement locationprocesses.

information,

Endpoints: updatePUT status,/inventory_device_serial_operation/{serial_number}/ andwith modifyvarious other attributesoperations based on physicalmaintenance verification.requirements

Use Case 5: DeviceEmergency LifecycleResponse Managementand Recovery

UpdateIn emergency situations where devices need immediate reconfiguration (such as security incidents or network changes), use the reconfiguration operation to quickly update device statussettings andwithout configurationwaiting duringfor differentstandard lifecyclesynchronization phasescycles.

(deployment,

Endpoints: activePUT use,/inventory_device_serial_operation/{serial_number}/ maintenance,with decommissioning)operation: using the serial number as the consistent identifier throughout the device's lifecycle."reconf"

---

Best Practices

Operation Selection:

• Use reboot for routine troubleshooting and after configuration changes that require a restart

Choose factory for complete device reset when reassigning or decommissioning devices Select device_factory when you need to reset user settings but preserve core device firmware and basic configurations Implement sync operations after any policy or configuration updates in your management system Use reconf for immediate configuration changes that cannot wait for scheduled synchronization

ValidateError SerialHandling:

Numbers:

• Always ensurecheck the response status code before proceeding with additional operations

Implement retry logic with exponential backoff for temporary network issues Log operation requests and responses for audit trails and troubleshooting Handle 404 errors gracefully when serial numbers aremay properly formatted andnot exist in the system

Security Considerations:

Validate serial numbers before making update requests to avoidprevent 404unauthorized errors.device access

Use Partial Updates: Only include fields that need to be updated in the request body. The API supports partial updates, so you don't need to send the entire device object.

Batch Operations: When updating multiple devices, implement proper rate limiting and consider processing devices in batches to avoid overwhelming the API.

Error Handling: Implement robust error handling for common scenarios like device not found (404) or invalid data (400/422). Log failed operations for troubleshooting and retry mechanisms.

Data Validation: Validate device data on the client side before sending requests, especially for fields like email addresses, dates, and enumerated values like status.

Idempotent Operations: Design your integration to be idempotent - the same update operation should be safe to retry without causing unintended side effects.

Audit Trail: Keep track of what changes are being made for compliance and troubleshooting purposes, as this endpoint modifies device records directly.

Security: Never log or expose API tokens in your application code or logs. Use secure credentialtoken storage and rotation practices.

practices for API authentication Log all device operations for security auditing and compliance requirements Implement rate limiting to prevent accidental mass operations that could disrupt services

---

Performance and Reliability:

Allow sufficient time between operations on the same device to ensure completion Monitor operation success rates and device response times to identify problematic devices Implement proper timeout handling as device operations may take time to complete Consider device time zones and usage patterns when scheduling automated operations

Integration Tips:

Store operation IDs returned in responses for tracking and correlation with device logs Implement webhooks or polling mechanisms to monitor operation completion status Use device serial numbers consistently across all inventory management systems Validate device operational status before attempting operations to avoid conflicts