schedule

Available methods

Description

Methods to retrieve information about scheduled actions.

Namespace:

schedule

Method: archiveActions

HTTP POST

Description:

Archive all actions in the given list.

Parameters:

  • string sessionKey

  • int array actionIds

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: cancelActions

HTTP POST

Description:

Cancel all actions in given list. If an invalid action is provided, none of the actions given will be canceled.

Parameters:

  • string sessionKey

  • int array actionIds

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: deleteActions

HTTP POST

Description:

Delete all archived actions in the given list.

Parameters:

  • string sessionKey

  • int array actionIds

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: failSystemAction

HTTP POST

Description:

Fail specific event on specified system

Parameters:

  • string sessionKey

  • int sid

  • int actionId

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: failSystemAction

HTTP POST

Description:

Fail specific event on specified system

Parameters:

  • string sessionKey

  • int sid

  • int actionId

  • string message

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: listAllActions

HTTP GET

Description:

Returns a list of all actions. This includes completed, in progress, failed and archived actions.

Parameters:

  • string sessionKey

Returns:

  • array :

  • struct action

    • int "id" - action ID

    • string "name" - action name

    • string "type" - action type

    • string "scheduler" - the user that scheduled the action (optional)

    • dateTime.iso8601 "earliest" - the earliest date and time the action will be performed

    • int "prerequisite" - ID of the prerequisite action (optional)

    • int "completedSystems" - number of systems that completed the action

    • int "failedSystems" - number of systems that failed the action

    • int "inProgressSystems" - number of systems that are in progress

Method: listAllArchivedActions

HTTP GET

Description:

Returns a list of actions that have been archived.

Parameters:

  • string sessionKey

Returns:

  • array :

  • struct action

    • int "id" - action ID

    • string "name" - action name

    • string "type" - action type

    • string "scheduler" - the user that scheduled the action (optional)

    • dateTime.iso8601 "earliest" - the earliest date and time the action will be performed

    • int "prerequisite" - ID of the prerequisite action (optional)

    • int "completedSystems" - number of systems that completed the action

    • int "failedSystems" - number of systems that failed the action

    • int "inProgressSystems" - number of systems that are in progress

Method: listAllCompletedActions

HTTP GET

Description:

Returns a list of actions that have been completed.

Parameters:

  • string sessionKey

Returns:

  • array :

  • struct action

    • int "id" - action ID

    • string "name" - action name

    • string "type" - action type

    • string "scheduler" - the user that scheduled the action (optional)

    • dateTime.iso8601 "earliest" - the earliest date and time the action will be performed

    • int "prerequisite" - ID of the prerequisite action (optional)

    • int "completedSystems" - number of systems that completed the action

    • int "failedSystems" - number of systems that failed the action

    • int "inProgressSystems" - number of systems that are in progress

Method: listArchivedActions

HTTP GET

Description:

Returns a list of actions that have been archived.

Parameters:

  • string sessionKey

Returns:

  • array :

  • struct action

    • int "id" - action ID

    • string "name" - action name

    • string "type" - action type

    • string "scheduler" - the user that scheduled the action (optional)

    • dateTime.iso8601 "earliest" - the earliest date and time the action will be performed

    • int "prerequisite" - ID of the prerequisite action (optional)

    • int "completedSystems" - number of systems that completed the action

    • int "failedSystems" - number of systems that failed the action

    • int "inProgressSystems" - number of systems that are in progress

Method: listCompletedActions

HTTP GET

Description:

Returns a list of actions that have completed successfully.

Parameters:

  • string sessionKey

Returns:

  • array :

  • struct action

    • int "id" - action ID

    • string "name" - action name

    • string "type" - action type

    • string "scheduler" - the user that scheduled the action (optional)

    • dateTime.iso8601 "earliest" - the earliest date and time the action will be performed

    • int "prerequisite" - ID of the prerequisite action (optional)

    • int "completedSystems" - number of systems that completed the action

    • int "failedSystems" - number of systems that failed the action

    • int "inProgressSystems" - number of systems that are in progress

Method: listCompletedSystems

HTTP GET

Description:

Returns a list of systems that have completed a specific action.

Parameters:

  • string sessionKey

  • int actionId

Returns:

  • array :

  • struct system

    • int "server_id"

    • string "server_name" - server name

    • string "base_channel" - base channel used by the server

    • dateTime.iso8601 "timestamp" - the time the action was completed

    • string "message" - optional message containing details on the execution of the action. For example, if the action failed, this will contain the failure text.

Method: listFailedActions

HTTP GET

Description:

Returns a list of actions that have failed.

Parameters:

  • string sessionKey

Returns:

  • array :

  • struct action

    • int "id" - action ID

    • string "name" - action name

    • string "type" - action type

    • string "scheduler" - the user that scheduled the action (optional)

    • dateTime.iso8601 "earliest" - the earliest date and time the action will be performed

    • int "prerequisite" - ID of the prerequisite action (optional)

    • int "completedSystems" - number of systems that completed the action

    • int "failedSystems" - number of systems that failed the action

    • int "inProgressSystems" - number of systems that are in progress

Method: listFailedSystems

HTTP GET

Description:

Returns a list of systems that have failed a specific action.

Parameters:

  • string sessionKey

  • int actionId

Returns:

  • array :

  • struct system

    • int "server_id"

    • string "server_name" - server name

    • string "base_channel" - base channel used by the server

    • dateTime.iso8601 "timestamp" - the time the action was completed

    • string "message" - optional message containing details on the execution of the action. For example, if the action failed, this will contain the failure text.

Method: listInProgressActions

HTTP GET

Description:

Returns a list of actions that are in progress.

Parameters:

  • string sessionKey

Returns:

  • array :

  • struct action

    • int "id" - action ID

    • string "name" - action name

    • string "type" - action type

    • string "scheduler" - the user that scheduled the action (optional)

    • dateTime.iso8601 "earliest" - the earliest date and time the action will be performed

    • int "prerequisite" - ID of the prerequisite action (optional)

    • int "completedSystems" - number of systems that completed the action

    • int "failedSystems" - number of systems that failed the action

    • int "inProgressSystems" - number of systems that are in progress

Method: listInProgressSystems

HTTP GET

Description:

Returns a list of systems that have a specific action in progress.

Parameters:

  • string sessionKey

  • int actionId

Returns:

  • array :

  • struct system

    • int "server_id"

    • string "server_name" - server name

    • string "base_channel" - base channel used by the server

    • dateTime.iso8601 "timestamp" - the time the action was completed

    • string "message" - optional message containing details on the execution of the action. For example, if the action failed, this will contain the failure text.

Method: rescheduleActions

HTTP POST

Description:

Reschedule all actions in the given list.

Parameters:

  • string sessionKey

  • int array actionIds

  • boolean onlyFailed - True to only reschedule failed actions, False to reschedule all

Returns:

  • int - 1 on success, exception thrown otherwise.