Description

Namespace: schedule

Method: cancelActions

Parameters:

• string sessionKey
• array:
  • int - action id

Returns:

• int - 1 on success, exception thrown otherwise.

Method: listAllActions

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.
    • dateTime.iso8601 "earliest" - The earliest date and time the action will be performed

Method: listArchivedActions

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.
    • dateTime.iso8601 "earliest" - The earliest date and time the action will be performed

Method: listCompletedActions

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.
    • dateTime.iso8601 "earliest" - The earliest date and time the action will be performed

Method: listCompletedSystems

Parameters:

• string sessionKey
• string 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

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.
    • dateTime.iso8601 "earliest" - The earliest date and time the action will be performed

Method: listFailedSystems

Parameters:

• string sessionKey
• string 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

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.
    • dateTime.iso8601 "earliest" - The earliest date and time the action will be performed

Method: listInProgressSystems

Parameters:

• string sessionKey
• string 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.