KMC Commander

What you can build

• Rank alarms that need a person

  alarmInstance objects arrive by page and day. The operator groups repeats by device, drops the ones that self-cleared, and proposes which alarm group should be notified.

  With Alarm Triage

• Close a schedule that leaks runtime

  Schedules and point trends sit behind one tag query. The operator matches equipment runtime to its schedule object and proposes the schedule edit when something runs unscheduled.

  With Schedule Leak

• Spot a sensor that stopped reporting

  curStatus and hisStatus travel with every value. The operator lists points whose status changed or whose curVal froze and proposes a device check with the trend attached.

  With Sensor Health

Requirements

• A KMC Commander license, either cloud or a local box, with the host set as the API base
• A user whose JWT can reach the project, or add-on credentials arranged with CommanderSupport@kmccontrols.com
• The alarms view role for alarm groups and customer-level groups
• Point uuids for writes, found by querying point and deviceRef== for the parent device

Authentication

A JSON Web Token sent as an Authorization: Bearer header on every request, copied from the user's Profile, API page or issued by Login as User, Get Assigned Licenses, and Set License; add-on vendors obtain a root token from KMC Commander support.

Limits

• Writes run first-in first-out; relinquishes run in a separate queue, and a repeat relinquish with the same timeout replaces the earlier one
• The all-trends project job should run only once at add-on initialization and can take hours on an old project
• The perPoint trend job returns at most the most recent 2 hours when the requested window exceeds 24 hours
• The Get Group Users bulk call accepts up to 3000 user ids

Questions and answers

Where does the JWT come from?

For a user, from the bottom-left profile icon in the UI under API, or by calling POST /api/login, GET /users/me/activelicenses, then GET /api/setlicense/{{licenseId}}, which sets the license and returns the token. Add-ons instead call GET /api/projects to receive a fresh JWT per project.

How fast can the API write points?

The documentation states the Write Point call has run upwards of 100 requests per second when the downstream network is healthy. For many writes it recommends schedules and events instead. Each write returns a jobId whose remoteJob records success or failure.

Is there a way to fetch trends for a whole project?

Yes, for add-ons. POST /api/project/trends creates a job that writes a file; timeWindow all is for first initialization only, and timeWindow perPoint with a start per point is the recommended incremental path. Poll the job object until tags.running is false.