recurringaction

Available methods

Description

Provides methods to handle Recurring Actions for Minions, Groups and Organizations.

Namespace:

recurringaction

Method: create

HTTP POST

Description:

Create a new recurring action.

Parameters:

  • string sessionKey

  • struct actionProps

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

      • MINION

      • GROUP

      • ORG

    • int "entity_id" - the ID of the target entity

    • string "name" - the name of the action

    • string "cron_expr" - the execution frequency of the action

    • boolean "test" - whether the action should be executed in test mode (optional)

Returns:

  • int id - the ID of the recurring action

Method: delete

HTTP POST

Description:

Delete recurring action with given action id.

Parameters:

  • string sessionKey

  • int actionId - ID of the action

Returns:

  • int id - the ID of the recurring action

Method: listByEntity

HTTP GET

Description:

Return a list of recurring actions for a given entity.

Parameters:

  • string sessionKey

  • string entityType - type of the target entity. Can be MINION, GROUP or ORG.

  • int entityId - ID of the target entity

Returns:

  • array :

  • struct recurring action information

    • int "id"

    • string "name"

    • int "entity_id"

    • string "entity_type"

    • string "cron_expr"

    • dateTime.iso8601 "created"

    • string "creator"

    • boolean "test"

    • boolean "active"

Method: lookupById

HTTP GET

Description:

Return recurring action with given action ID.

Parameters:

  • string sessionKey

  • int actionId - ID of the action

Returns:

  • * struct recurring action information

    • int "id"

    • string "name"

    • int "entity_id"

    • string "entity_type"

    • string "cron_expr"

    • dateTime.iso8601 "created"

    • string "creator"

    • boolean "test"

    • boolean "active"

Method: update

HTTP POST

Description:

Update a recurring action.

Parameters:

  • string sessionKey

  • struct actionProps

    • int "id" - the ID of the action to update

    • string "name" - the name of the action (optional)

    • string "cron_expr" - the execution frequency of the action (optional)

    • boolean "test" - whether the action should be executed in test mode (optional)

    • boolean "active" - whether the action should be active (optional)

Returns:

  • int id - the ID of the recurring action