Skip to main content

Update Event With Progress

Description​

Updates event with progress via the web service.

Function Signature:​

def update_event_with_progress(ws_config: WebServiceConfig, event_id: int, event_status: int, result_string: str, process_id: int, tag_string: str = '', tag_number: int = 0, percent_complete: float = 0, attempt_number: int = 1) -> StandardResult:

Parameters​

  • ws_config (WebServiceConfig): Configuration for the web service connection.
  • event_id (int): Event identifier.
  • event_status (int): Event status value.
  • result_string (str): Result or status message.
  • process_id (int): Process identifier.
  • tag_string (str): Tag string.
  • tag_number (int): Tag number value.
  • percent_complete (float): Completion percentage.
  • attempt_number (int): Attempt number.

Returns​

  • StandardResult: A result object containing:
    • code: HTTP status code (200 for success, -1 for exceptions).
    • description: Response body or error message.

Example Usage​

# Example usage
ws_config = WebServiceConfig(access_key="key", secret_key="secret", base_url="https://api.example.com/")
event_id = 1
event_status = 1
result_string = "example"
process_id = 1
tag_string = "example"
tag_number = 1
percent_complete = 0.0
attempt_number = 1
result = update_event_with_progress(ws_config, event_id, event_status, result_string, process_id, tag_string, tag_number, percent_complete, attempt_number)
print(result)

Behavior​

  • Sends a signed request to the web service.
  • On success, returns the computed value or result object.

Error Handling​

  • Exceptions set the result code to -1 and include an error message when implemented.