RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from http://spacewalkproject.github.io/documentation/api/2.10/handlers/ScheduleHandler.html below:

( Return to API Overview ) Available methods

archiveActions
cancelActions
deleteActions
failSystemAction
failSystemAction
listAllActions
listArchivedActions
listCompletedActions
listCompletedSystems
listFailedActions
listFailedSystems
listInProgressActions
listInProgressSystems
rescheduleActions

Description Methods to retrieve information about scheduled actions.

Namespace: schedule

Method: archiveActions Description:
Archive all actions in the given list. Parameters:

string sessionKey
array:
- int - action id

Returns:


 
  int - 1 on success, exception thrown otherwise.

Method: cancelActions Description:
Cancel all actions in given list. If an invalid action is provided, none of the actions given will canceled. Parameters:

string sessionKey
array:
- int - action id

Returns:


 
  int - 1 on success, exception thrown otherwise.

Method: deleteActions Description:
Delete all archived actions in the given list. Parameters:

string sessionKey
array:
- int - action id

Returns:


 
  int - 1 on success, exception thrown otherwise.

Method: failSystemAction Description:
Fail specific event on specified system Parameters:

string sessionKey
int serverId
int actionId

Returns:


 
  int - 1 on success, exception thrown otherwise.

Method: failSystemAction Description:
Fail specific event on specified system Parameters:

string sessionKey
int serverId
int actionId
string message

Returns:


 
  int - 1 on success, exception thrown otherwise.

Method: listAllActions 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 "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 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 "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 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 "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 Description:
Returns a list of systems that have completed a specific action. 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 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 "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 Description:
Returns a list of systems that have failed a specific action. 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 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 "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 Description:
Returns a list of systems that have a specific action in progress. 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: rescheduleActions Description:
Reschedule all actions in the given list. Parameters:

string sessionKey
array:
- int - action id
boolean onlyFailed - True to only reschedule failed actions, False to reschedule all

Returns:


 
  int - 1 on success, exception thrown otherwise.

Generated on 3/4/2020

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4