recurring

Available methods

Description

Provides methods to handle recurring actions for minions, system groups and organizations.

Namespace:

recurring

Method: delete

HTTP POST

Description:

Delete a recurring action with the given action ID.

Parameters:

  • string sessionKey

  • int id - the action ID

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: listByEntity

HTTP GET

Description:

Return a list of recurring actions for a given entity.

Parameters:

  • string sessionKey

  • string "type" - the type of the target entity. One of the following:

    • minion

    • group

    • org

  • int id - the ID of the target entity

Returns:

  • array :

  • struct recurring action information (some fields may be absent for some action types)

    • int "id"

    • string "name"

    • int "entity_id"

    • string "entity_type"

    • string "cron_expr"

    • dateTime.iso8601 "created"

    • string "creator"

    • boolean "test"

    • string array "states" - the ordered list of states to be executed by a custom state action

    • boolean "active"

Method: lookupById

HTTP GET

Description:

Find a recurring action with the given action ID.

Parameters:

  • string sessionKey

  • int id - the action ID

Returns:

  • * struct recurring action information (some fields may be absent for some action types)

    • int "id"

    • string "name"

    • int "entity_id"

    • string "entity_type"

    • string "cron_expr"

    • dateTime.iso8601 "created"

    • string "creator"

    • boolean "test"

    • string array "states" - the ordered list of states to be executed by a custom state action

    • boolean "active"