API Changelog

Learn about new features, updates, improvements, and bug fixes to the ISAAC API.

2.4.1 - July 24th, 2024

Improvements

For better readability and audience's interest, the changelog for ISAAC API has been removed from the product Changelog and is now available here, as well as online on the Integration Partner Portal's page and on-demand. [ISAAC-S-1265].
The behavior of ISAAC API with regards to True PUT/PATCH methods has been documented in the API Guide [ISAAC-S-1254].
The REST API /api/v1/controlpanels endpoints now accept relative paths for Control Panel's type iframe, relying on ISAAC address for the full Control Panel URL [ISAAC-S-1338].

Bug Fixes

Documentation for heartbeat messages is missing in swagger and the API Guide [ISAAC-S-1347].
Heartbeat Identify messages are not sent even when a module states it supports it, except for BrightSign module [ISAAC-S-1318].

2.4.0 - May 31st, 2024

Improvements

The REST API DELETE /api/v1/assets is now protected against the deletion of Assets that are owned and managed by other ISAAC entities.
The REST API /api/v1/subsystem/:id/compositions endpoint have been deprecated [ISAAC-S-1215]

Bug Fixes

REST API POST/PUT /api/v1/events does not enforce uniqueness of displayName property [ISAAC-S-975].
REST API POST/PUT /api/v1/compositions does not enforce uniqueness of displayName property [ISAAC-S-1128].
REST API POST/PUT /api/v1/playables does not enforce uniqueness of displayName property [ISAAC-S-1102].
REST API GET /api/v1/compositions returned payload templatePath property does not match the swagger schema, it should be an object with only the name and the group of the template [ISAAC-S-1099].
REST API DELETE /api/v1/playables/orphan swagger definition for the returned payload is incorrect [ISAAC-S-1098].
REST API GET /api/v1/users swagger definition for the returned payload is incorrect [ISAAC-S-903].
REST API POST/PUT /api/v1/assets does not enforce uniqueness of displayName property [ISAAC-S-883].
REST API GET /api/v1/infra/assets/{id}/historicCounts endpoint returned payload is missing the metricsChangeHistory property in the _links object [ISAAC-S-881].
REST API POST /api/v1/infra/assets endpoint returned payload is missing the self property in the _links object [ISAAC-S-870].
REST API PUT /api/v1/assets clears fields that are not specified in the payload instead of preserving their values [ISAAC-S-879].
REST API GET /api/v1/assets endpoint payload does return an invalid _updatedAt value when the property is not set [ISAAC-S-871].
REST API DELETE /api/v1/variables endpoint does not protect the deletion of metrics (variables) that are owned and managed by an Asset [ISAAC-S-873].
REST API GET /api/v1/assets/{id}/historicCounts endpoint returns lastValue property as "undefined" value in its payload instead of "" when the value is not defined [ISAAC-S-867].
REST API POST /api/v1/controlpanels endpoint expects a location parameter, but if omitted, it'll default to available even if the payload contains "location": "registered" [ISAAC-S-1178].
REST API GET /api/v1/playables/{id}/copyToPlayerStatus response missed the _links property as defined in its swagger definition [ISAAC-S-1111].
REST API PUT /api/v1/subsystem/:id/variables/:externalRef and PUT /api/v1/subsystem/:id/events/:externalRef endpoints don't handle the externalRef value correctly, if the externalRef property passed in the payload is different from the parameter value [ISAAC-S-1210/ISAAC-S-1206].
REST API GET /api/v1/subsystems/... endpoints do not return itemCounts' properties as integers [ISAAC-S-1199/ISAAC-S-1221/ISAAC-S-1198].
REST API GET /api/v1/subsystems/... endpoints do not return the container property [ISAAC-S-1220].
The uniqueness of the property externalId of subsystems is not enforced which can cause duplicated values [ISAAC-S-1222].
The REST API GET /api/v1/subsystems/:externalRef/variables/:externalVarRef returned payload does not match its swagger definition, missing returned properties [ISAAC-S-1202].
Calling the REST API PUT /api/v1/events without the displayName or the description fields provided overwrites them to empty [ISAAC-S-979].

2.3.3 - December 8th, 2023

Improvements & Bug Fixes

The REST API endpoints PUT /api/v1/backups/:id/verify & PUT /api/v1/backups/:id/restore do not return an expected 404 error, when the given backup id doesn't exist [ISAAC-S-802]
The REST API endpoints POST /api/v1/notifications/<id>/show, POST /api/v1/notifications/<id>/clear and POST /api/v1/notifications/<id>/action do not return 404 when the given id does not exist [ISAAC-S-804]
The REST API endpoint POST /api/v1/users does return 201 instead of 403 when the maximum number of allowed users is reached [ISAAC-S-783]
The REST API endpoint GET /api/v1/playables/<id>/instances does not return an expected 404 error, when the given playable id doesn't exist [ISAAC-S-805]
The REST API endpoint GET /api/v1/players/<id>/defaultState does not return an expected 404 error, when the given Player id doesn't exist [ISAAC-S-807]
The REST API endpoint PUT /api/v1/roles/<id> does not return an expected 404 error, when the given role id doesn't exist [ISAAC-S-809]
The REST API endpoint POST /api/v1/users documentation does not indicate the password property as mandatory [ISAAC-S-806]
The REST API endpoint POST /api/v1/users response payload is not properly documented [ISAAC-S-808]
The REST API endpoint GET /api/v1/infra/assets/<id>/network/historicCounts does not return 404 when the asset id doesn't exist but instead a pseudo answer which contains the non existing given assetId [ISAAC-S-803]
Some of the REST API endpoints' documentation don't have the 404 response documented [ISAAC-S-641]
Some of the REST API endpoints in /api/v1/settings, /api/v1/subsystems, /api/v1/license and /api/v1/webhook have incorrect or missing documentation [ISAAC-S-642]
Some of the REST API endpoints in /api/v1/users, /api/v1/roles, /api/v1/variables, /api/v1/infra/assets and /api/v1/usertemplates have incorrect or missing documentation in 200, 400 and 401 responses [ISAAC-S-792/ISAAC-S-793]
Some of the REST API endpoints in /api/v1/playlists, /api/v1/schedules and /api/v1/zones have incorrect or missing documentation in 200, 404 and 500 responses as well as headers' format [ISAAC-S-794/ISAAC-S-834]
Some of the REST API endpoints in /api/v1/playables and /api/v1/players have incorrect or missing documentation (responses payload) [ISAAC-S-795]
The REST API endpoints in /api/v1/alerts documentation for returned alerts payload is incorrect [ISAAC-S-835]
The REST API endpoints POST/PUT /alerts return 200 instead of 409 if the name of the alert is set to an already existing one [ISAAC-S-840]

2.3.2 - October 12th, 2023

Bug Fixes

The REST API endpoints DELETE /api/v1/settings/background and DELETE /api/v1/settings/logo were documented although not implemented [ISAAC-S-724]
The REST API endpoint DELETE /api/v1/playlists/{id} does not return any payload [ISAAC-S-722]
The REST API endpoint GET /variables/{id}/history returns invalid data for some metrics (unexpected objets) [ISAAC-S-714]
The REST API endpoint `DELETE /api/v1/integrations/webhooks/{id} returns a webhook object with empty properties instead of the expected response payload [ISAAC-S-708]
The REST API endpoint DELETE /api/v1/schedule/zones/{id} response payload does not contain impacted items [ISAAC-S-707]
The REST API endpoints GET/PUT /subsystems/{externalId}/variables/{externalRef}/lastValue are not documented properly [ISAAC-S-732]
The REST API endpoint GET /players?container={id} does not filter the Players properly and is returning other Players as well [ISAAC-S-741]
Some REST API DELETE endpoints don't have the payload of 200 return code properly documented [ISAAC-S-640]
The REST API endpoint POST /users documentation does not specify that it requires the roleIds property to be provided [ISAAC-S-742]
The swagger specification for the endpoint DELETE /api/v1/subsystems/{id} is incorrect and the endpoint does not properly return the list of affected items [ISAAC-S-726]
Instant Play feature usage is missing in the API Guide [ISAAC-S-733/ISAAC-S-683]

‍

2.3.1 - August 29th, 2023

Improvments

Improvement of the API Guide on externalRef parameter and heartbeat endpoint usage [ISAAC-S-637/ISAAC-S-682]

Bug Fixes

The REST API or Schedule TCP payloads for playables and events items do not provide externalRef property [ISAAC-S-634]
The REST API GET /scheduledItems?beforeCount=x endpoint returns more than x items in the past [ISAAC-S-674]
The REST API api/v1/schedule/calendars endpoints are incorrectly documented into the swagger specifications. Certain endpoints' definition do not exist and have been removed [ISAAC-S-633]
The REST API PUT /subsystems/{externalId}/variables/{externalRef} endpoint property availableInSubsystem is defaulted to false instead of true, which causes the variable to appear as a broken link [ISAAC-S-668]
The REST API POST /notifications/show endpoint clears notifications instead of marking them as shown [ISAAC-S-663]
The REST API PUT /variables/{id} endpoint returns a 500 error when the property healthGracePeriod is greater than 0 (> 0) [ISAAC-S-647]
The REST API PUT /api/v1/variables/{id} endpoint property healthEnabled is defaulted to false instead of true, which causes the variable health state to not refresh anymore when the health status changes [ISAAC-S-645]
The REST API DELETE /api/v1/events/{systemId}/{externalRef} endpoint does not work if the externalRef value only contains numerical characters [ISAAC-S-627]
The REST API PUT /api/v1/variable/lastValue/{systemId}/{variableName} endpoint is not working anymore which breaks backward compatibility [ISAAC-S-614]

2.3.0 - July 21st, 2023

Improvements

A new API Guide provides guidance for integrating Subsystems with ISAAC

Bug Fixes

REST API GET /api/v1/schedule?objectList=true response has an empty object in it which is not expected. [ISAAC-S-353]
REST API user panels endpoints (ex GET /api/v1//users/{id}?availablePanels) return a 500 error message. [ISAAC-S-442]
Some REST API endpoints are returning the header Content-Type as application/json; charset=utf-8 instead of application/json [ISAAC-S-376]
Newly created panels are not returned by GET /api/v1//users/{id}?availablePanels endpoint [ISAAC-S-383]
REST API GET /api/v1//platform/host/actions/system/shutdown return a 500 error message, although the shutdown did happen [ISAAC-S-563]
REST API DELETE /api/v1/events/{{ID}} accepts random text as ID, which causes deletion of unwanted event [ISAAC-S-562]
REST API, some endpoints such as GET /api/v1/users randomly return 500 error [ISAAC-S-465]
REST API GET /api/v1/schedule returns 500 Internal Server Error if the header if-modified-since is passed, which breaks modules' integration using it [ISAAC-S-603]
REST API GET /api/v1/schedule items payload's properties startTimeLocal and endTimeLocal are missing time fraction part, which may break some modules' integration [ISAAC-S-595]
REST API GET /api/v1/schedule?subsystemExternalId= does not return 404 Not Found as expected when a non existing subsystemExternalId parameter is provided [ISAAC-S-600]
REST API PUT /api/v1/controlpanels/{id} returns 500 Internal Server error when the full control panel object is provided as payload [ISAAC-S-594]
REST API PUT/POST /api/v1/variables endpoints do not accept the playload property subsystemId provided as a string anymore (only as a number) and returns a 400 error message. While the update of the specification requires now to pass this property as a number, a string value is now still accepted for backward compatibility reason, as long as the string converts into a non zero number [ISAAC-S-602]
REST API PUT/POST /api/v1/variables endpoints require subsystemId as a mandatory field, whereas only subsystemExternalId field is specified to be mandatory to identify the Subsystem [ISAAC-S-620]

API Changelog

Learn about new features, updates, improvements, and bug fixes to the ISAAC API.

Workspace

Platform

Ecosystem

Resources

ISAAC is developed by

Contact

Main Office

Showroom

Privacy Policy

ISAAC and the ISAAC “3 layer” logo and design are registered trademarks of Smart Monkeys, Inc. All other marks and names mentioned herein may be trademarks of their respective companies.
‍
© Smart Monkeys, inc. All right reserved.

API Changelog

Learn about new features, updates, improvements, and bug fixes to the ISAAC API.

Workspace

Platform

Ecosystem

Resources

ISAAC is developed by

Contact

Main Office

Showroom

Privacy Policy

ISAAC and the ISAAC “3 layer” logo and design are registered trademarks of Smart Monkeys, Inc. All other marks and names mentioned herein may be trademarks of their respective companies.‍© Smart Monkeys, inc. All right reserved.

ISAAC and the ISAAC “3 layer” logo and design are registered trademarks of Smart Monkeys, Inc. All other marks and names mentioned herein may be trademarks of their respective companies.
‍
© Smart Monkeys, inc. All right reserved.