Bulk rollout
POST/api/public/my-display-bulk-rollouts
Create a new rollout(s) for a specified programs on specified devices or/and organizations. There are 3 options to use the API.
1. Default configurations: If no MyDisplay templates are provided (myDisplayTemplateIds) then System Default Template is used to generate MyDisplays.
The minimal parameters in this case are:
what needs to be rolled out cookingProgramIds or/and adminCookingProgramIds, where 'deviceIds' or/and 'groupIds', and when 'releaseDate' or/and 'rolloutDate'.
System Default Template can be additionally modified by standardCookingProgramIds, password, locale, countryCuisineId, deleteAllPrograms and systemShortcuts properties.
2. Default MyDisplay templates: Default MyDisplay templates can be defined via ConnectedCooking.
When there is defined a default template for a device family then the minimal parameters in this case are:
what needs to be rolled out cookingProgramIds, where 'deviceIds' or/and 'groupIds', and when 'releaseDate' or/and 'rolloutDate'.
All other properties will be ignored for that device family.
3. Providing explicitly MyDisplay template IDs: The myDisplayTemplateIds must be provided with specified IDs of a custom MyDisplay templates form the ConnectedCooking.
Those templates will be taken with priority before the default MyDisplay templates per device family. The minimal parameters in this case are:
what needs to be rolled out cookingProgramIds, where 'deviceIds' or/and 'groupIds', when 'releaseDate' or/and 'rolloutDate', and 'myDisplayTemplateIds' for the custom configurations.
All other properties will be ignored for that device family.
This API is only available if you have the ERP-API feature enabled. It is not available in the Basic-API level. See API access for more details.
In case 2 and 3 - when a mydisplay template is used (default or provided in the request), then the programs will be placed on the dynamic screen defined in the profile of the MyDisplay template.
Request
Responses
- 200