slControl API

LogoutChangelog (26.08.2024)Legal notesBasic usageRequest EmulatorTroubleshooting
Global
Get list of accessible customersGet lookup tables for settingsGet lookup tables for devicesGet lookup tables for operationModeGet lookup tables for gatewaysGet lookup tables for jobsGet lookup tables for alerts
Customers
Get customer configurationUpdate customer configurationGet mesh network
Groups
Get group tree
Lamp switches
Get lamp switchesUpdate lamp switches
Luminaire points
Get luminaire pointsUpdate luminaire pointsCreate luminaire pointsDelete luminaire points
Devices
Get devicesGet device dataGet device stateUpdate device dataUpdate device operation stateGet operation modeUpdate operation modeDelete deviceDelete devices
Devices - Statistics/Logs
Get radar dataGet motion dataGet device energyGet environmental data
Gateways
Get gatewaysGet gateway dataCreate gatewaysDelete a gateway
Jobs
Get jobs state of a deviceGet job state by slcID
Alerts
Get alertsCreate alertsUpdate alerts

Get job state by slcID

Request state of any job by slcID.

API endpoint

jobStatus/slcID of field communication job

Request method

GET

Request headers

-

Request URL parameters

-

Response content

EntityTypeNullableDescription
jobStatusarray (mainEntity)no

mainEntity

EntityTypeNullableDescription
idintnoslcID of job
date_createdtimestampnoDate and time of job creation
type_idint (jobType)nojob type
state_idint (jobState)nojob state
customer_idintnoslcID of customer
date_updatedtimestampyesDate and time of last job update
no_restartsintyesnumber of job restarts
device_idintyesslcDeviceAddress
device_idsint[]yesslcDeviceAddresses (job types 12 and 13)
gateway_idintyesslcID of gateway
successful_device_idsint[]yesslcDeviceAddresses (job types 12 and 13)
failed_device_idsint[]yesslcDeviceAddresses (job types 12 and 13)

jobType

ValueDescription
1System-Einstellungen aktualisieren
2Gatweway-Einstellungen aktualisieren
3Betriebsmodus aktualisieren
4Bewegungszähler zurücksetzen
5Leuchte inaktiv schalten
6Statische Gerätedaten ändern
7Manuelle LED-Helligkeit wurde geändert
8Gerätestatus und Sensordaten aktualisieren
9Die "Übergeordneter Lichtschalter-Konfiguration" wurde geändert
10Sendet einen "übergeordneter Lichtschalter" - Befehl aus
11Nachbargeräte für Bewegungserkennung wurden geändert
12Der gleiche Betriebsmodus wurde für mehrere Geräte gesetzt
13Die gleiche "Übergeordneter Lichtschalter-Konfiguration" würde für mehrere Geräte gesetzt
14Empfangsdaten (Mesh-Net) aktualisieren
15Status-Log-Daten aktualisieren
16Geräte-Roh-Kommando (Debug)
17Gateway ExtOut Command
18Device Update RalabMotionSensor Config
19Device Reset Radar Motion Counters
20Device Set LFC
21Dist Measurement Value Config

jobState

ValueDescription
0Pendent
1In Arbeit
2Erledigt
3Fehler
4Archiv
5Teilweise Fehlgeschlagen
6Eskalation

Response on success

Headers

200 OK

Content (example)

{
	"jobStatus": [
		{
			"id": 533192,
			"customer_id": 165,
			"type_id": 1,
			"state_id": 2,
			"date_created": "2018-06-19T15:02:44+02:00",
			"date_updated": "2018-06-19T15:02:45+02:00"
		}
	]
}

Response on error

Headers

400 Bad Request

Content (example)

{
	"error": 5001
}

Error Codes

CodeDescription
5001job not found