Implement function to activate/deactivate planned scenario

[SherekhanFR]

Hello team ! In some use cases happy user of pyoverkiz would need to activate / desactivate a planned scenario. I don’t think this is doable with current version. It would be cool to have a method which takes a scenario identifier and a target status. Thanks !

[iMicknl]

Can you activate / deactivate this via the official app? I am not using this feature, thus not sure how this works..

[SherekhanFR]

Hello Mick,

yes this is possible via a switch button

it throws a bunch of API calls when I toggle off the button :

step 1 PUT enduser-mobile-web/enduserAPI/setup/calendar/days

it seems the state is passed in "enabled" tag

{
  "dayTimeTriggers": [
    {
      "startActionGroupTimeTrigger": {
        "enabled": false,

but the full scenario description (action groups, ...) in is the call...

step 2 GET enduserAPI/setup/calendar/days/{oid from step 1}

seems to get the same data as the one passed in step 1 API call

step 3 PUT enduserAPI/setup/calendar/ruleSet

seems to pass the activation dates

step 4 GET enduserAPI/exec/schedule

seems to exec/activate the schedule

step 5 enduserAPI/setup/calendar/rules/{oid from step 3}

seems to get the same data as the one passed in step 3 API call

step 6 GET enduserAPI/exec/schedule

seems again to exec/activate the schedule

step 7 enduserAPI/setup/calendar/rules/{oid from step 3}

seems again to get the same data as step 3 API call (same response as step 3)

to sumup :

• maybe only step 1 is needed to update status but the API call seems to need all the scenario parameters which means we have to get it before with similar call than step 2
• other calls seem redondant except exec/schedule which maybe "compile" the scenario for activation
• this possibility of enabling / disabling scenario with API for custom integration seems not the have been designed by overkiz and the risk is to break the scenario.

[iMicknl]

Apologies for the delay in reply.

We can definitely support this in the pyoverkiz library, but I don't have time to collect all the details. Can you perhaps collect the exact url? The input payload and the exact output? I am happy to add this to the library.

[iMicknl]

@SherekhanFR are you still interested in this?

[SherekhanFR]

Hi @iMicknl, yes I'm still interested in this. For the time being I have applied a "reverse" scenario. Unfortunately I was not able to find which url were called precisely => I will check and get back to you.