AXM icon

AXM

Read and write data in the AXM physical access control system

Lock → Create

AI-generated

Summary

Create a new lock in the AXM physical access control system associated with a specified lock system and building, configuring its type, name, and optional details.

Inputs

  • Lock System ID (required) — The identifier of the lock system to which the lock belongs.
  • Name (required) — The name assigned to the new lock.
  • Lock Type (required) — The type of the lock, chosen from predefined options like Cylinder, Smart Handle, Fortlox, etc.
  • Building ID (required) — The identifier of the building where the lock is located.
  • Tags — Comma-separated list of tag names associated with the lock; use empty string for none.
  • Additional Fields — Optional fields including Area ID, Description, Door Code, Level, and Room Number to further specify lock details.

Output shape

a single record representing the created lock with its properties

This operation sends a POST request to the AXM API endpoint '/api/process-command/CreateLock' and returns the response JSON describing the newly created lock.

Examples

Example 1: Create a lock with required and optional fields

Set 'Lock System ID', 'Name', 'Lock Type', and 'Building ID'. Optionally provide tags and additional fields like Area ID and Door Code to create a detailed lock record.

Links

Discussion