Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
Table of Contents
maxlevel1

...

Universal Controller supports the following RESTful-based web service for Universal Events.

The Universal Event Publishing web service is allowed only for users with the ops_admin role.

Formatting specifications for the web service, including details about parameter requirements, are provided.

...

HTTP Method

...

Example URI

...

  • Status 200

    • Universal Event "{eventname}" published.

  • Status 400

    • Invalid Time To Live. Value must be non-negative or empty.

    • Universal Event attributes unknown for Universal Event Template "{eventname}".

    • Universal Event attribute name required.

    • Universal Event attribute "{attributename}" duplicated.

    • Universal Event attribute "{attributename}" unknown for Universal Event Template "{eventname}".

    • Universal Event attribute value "{attributevalue}" for attribute "{attributename}" is not a valid integer.

    • Universal Event attribute value "{attributevalue}" for attribute "{attributename}" is not a valid float.

  • Status 403

    • Operation prohibited due to security constraints.

  • Status 404

    • Universal Event Template "{eventname}" not found.

    • A universal template with id "{templateid}" does not exist.

  • Status 500

    • Unexpected request failure. See log(s) for more details.

...

Universal Event Publishing: Example Request

...

XML Request

...

JSON Request

...

titleXML

...

Panel
Table of Contents
maxlevel1

Anchor
Overview
Overview
Overview

Universal Controller supports the following RESTful-based web service for Universal Events.

Formatting specifications for the web service, including details about parameter requirements, are provided.

Authorization to publish a Universal Event is assigned by the Universal Event Create permission, or by the ops_admin role.

Note
titleNote

When publishing Universal Events through the Web Service API, take into consideration both Universal Controller server and Database server sizings.

Anchor
Universal Event Publishing
Universal Event Publishing
Publish Universal Event


Description
URIhttp://host_name/uc/resources/universalevent/publish
DescriptionPublsh a global Universal Event.

HTTP Method

POST

Example URI

http://localhost:8080/uc/resources/universalevent/publish
AuthenticationHTTP Basic
Consumes Content-Typeapplication/xml, application/json
Produces Content-Typen/a
Example Responses
  • Status 200

    • Universal Event "{eventname}" published.

  • Status 400

    • Invalid Time To Live. Value must be non-negative or empty.

    • Universal Event attributes unknown for Universal Event Template "{eventname}".

    • Universal Event attribute name required.

    • Universal Event attribute "{attributename}" duplicated.

    • Universal Event attribute "{attributename}" unknown for Universal Event Template "{eventname}".

    • Universal Event attribute value "{attributevalue}" for attribute "{attributename}" is not a valid integer.

    • Universal Event attribute value "{attributevalue}" for attribute "{attributename}" is not a valid float.

  • Status 403

    • Operation prohibited due to security constraints.

  • Status 404

    • Universal Event Template "{eventname}" not found.

    • A universal template with id "{templateid}" does not exist.

  • Status 500

    • Unexpected request failure. See log(s) for more details.


Anchor
Universal Event Publishing Examples
Universal Event Publishing Examples
Publish Universal Event: XML and JSON Example Request

XML Request

JSON Request

Expand
titleXML
<?xml version="1.0" encoding="UTF-8" ?>
<universalEvent>
  <name>ExampleEvent</name>
  <businessServices>
    <businessService>BusinessServiceName1</businessService>
    <businessService>BusinessServiceName2</businessService>
  </businessServices>
  <ttl>60</ttl>
  <attributes>
    <attribute>
      <name>example_attribute2<attribute1</name>
      <value>Value2<<value>Value1</value>
    </attribute>
  </attributes> </universalEvent>
Expand
titleJSON

...

Valid values: One of the following (not case sensitive):

  • As String = User Interface, As Value = 1
  • As String = Command Line, As Value = 2
  • As String = Web Service, As Value = 3
  • As String = System Operation, As Value = 4
  • As String = Set Variable Action, As Value = 5
  • As String = Task Instance, As Value = 6
  • As String = Agent Message, As Value = 7
  • As String = Scheduled, As Value = 8
  • As String = Stored Procedure, As Value = 9
  • As String = System Processing, As Value = 10
  • As String = Email Notification, As Value = 11

...

Valid values:

  • mn (minutes)
  • h (hours)
  • d (days)

Default is d.
 
Examples: -5d (last 5 days), -30mn (last 30 minutes), -6h (last 6 hours), -7 (last 7 days).
 
If updatedTimeType is Since; date/time value (yyyy-MM-dd [HH:mm:ss])
 
If updatedTimeType is Today; updatedTime is ignored.

...

Valid values:

  • As String = Today, As Value = 1
  • As String = Offset, As Value = 2
  • As String = Since, As Value = 3
  • As String = Older Than, As Value = 4

...

Created By

...

Name of the person created the record.

...

Status of the record

...

boolean property

Valid values: true, false, 1, 0

...

List Audit Records: Example Response

...

XML Response

...

JSON Response

...

Expand
titleXML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<audits>
    <audit>
        <childAudits/>
        <auditType>User Login</auditType>
        <created>2020-03-04 13:33:09 -0500</created>
        <createdBy>ops.system</createdBy>
        <description>LOGIN <user=ops.admin, ipaddr=127.0.0.1></description>
        <nodeId>SBUS30:8080-opswise8</nodeId>
        <nodeMode>Active</nodeMode>
        <source>User Interface</source>
        <status>Login OK</status>
        <sysId>1583346757585450235STIHZ8DE02AZB</sysId>
        <tableKey>e0bde364c0a802ba0092e79554132023</tableKey>
        <tableName>ops_user</tableName>
        <tableRecordName>Administrator</tableRecordName>
        <updated>2020-03-04 13:33:09 -0500</updated>
        <updatedBy>ops.system</updatedBy>
        <uuid>1583346757585450235STIHZ8DE02AZB</uuid>
    </audit>

...

Expand
titleJSON

[
  {
    "additionalInfo": null,
    "after": null,
    "auditType": "User Login",
    "before": null,
    "childAudits": [],
    "created": "2020-03-04 13:33:09 -0500",
    "createdBy": "ops.system",
    "description": "LOGIN <user=ops.admin, ipaddr=127.0.0.1>",
    "difference": null,
    "nodeId": "SBUS30:8080-opswise8",
    "nodeMode": "Active",
    "parentAudit": null,
    "routedFrom": null,
    "source": "User Interface",
    "status": "Login OK",
    "sysId": "1583346757585450235STIHZ8DE02AZB",
    "tableKey": "e0bde364c0a802ba0092e79554132023",
    "tableName": "ops_user",
    "tableRecordName": "Administrator",
    "universalTemplate": null,
    "updated": "2020-03-04 13:33:09 -0500",
    "updatedBy": "ops.system",
    "uuid": "1583346757585450235STIHZ8DE02AZB"
  }
]

List Audit Records: Example Response with Child Audits

XML Response with Child Audits

JSON Response with Child Audits

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <audit>
        <childAudits>
            <childAudit>
                <childAudits/>
                <after>TaskWindowsBean [ {agent=094e2a6b2da747d09f4882cdc136dc49} {agent_cluster=null} {agent_cluster_var=null} {agent_cluster_var_check=false} {agent_var=null} {agent_var_check=false} {avg_run_time=null} {broadcast_cluster=null} {broadcast_cluster_var=null} {broadcast_cluster_var_check=false} {checksum=null} {command=echo $} {command_or_script=Command} {cp_duration=null} {cp_duration_unit=Minutes} {create_console=false} {credentials=null} {credentials_var=null} {credentials_var_check=false} {custom_field1=null} {custom_field2=null} {desktop_interact=false} {ef_day_constraint=None} {ef_duration=00:00:00:00} {ef_enabled=false} {ef_nth_amount=5} {ef_offset_duration=null} {ef_offset_duration_unit=Minutes} {ef_offset_percentage=0} {ef_offset_type=Percentage} {ef_time=00:00} {ef_type=Time} {elevate_user=false} {environment=null} {exec_counter=0} {execution_restriction=None} {exit_code_output=null} {exit_code_processing=Success Exitcode Range} {exit_code_text=null} {exit_codes=0} {first_run=null} {hold_resources=false} {last_run=null} {last_run_time=null} {lf_day_constraint=None} {lf_duration=00:00:00:00} {lf_enabled=false} {lf_nth_amount=5} {lf_offset_duration=null} {lf_offset_duration_unit=Minutes} {lf_offset_percentage=0} {lf_offset_type=Percentage} {lf_time=00:00} {lf_type=Time} {ls_day_constraint=None} {ls_duration=00:00:00:00} {ls_enabled=false} {ls_nth_amount=5} {ls_time=00:00} {ls_type=Time} {max_run_time=null} {min_run_time=null} {name=test-1} {opswise_groups=null} {output_failure_only=false} {output_return_file=null} {output_return_nline=100} {output_return_sline=1} {output_return_text=null} {output_return_type=NONE} {output_type=STDOUT} {parameters=null} {res_priority=10} {resolve_name_immediately=false} {restriction_period=None} {retry_exit_codes=null} {retry_indefinitely=false} {retry_interval=60} {retry_maximum=0} {retry_suppress_failure=false} {rp_after_date=null} {rp_after_time=null} {rp_before_date=null} {rp_before_time=null} {rp_date_list=null} {run_as_sudo=false} {run_count=0} {run_time=0} {runtime_dir=null} {script=null} {start_held=false} {start_held_reason=null} {summary=test1} {sys_class_name=ops_task_windows} {sys_created_by=ops.admin} {sys_created_on=2020-04-24 15:42:07 -0400} {sys_id=f900ebd674674dbdb3f5499ed20cfecb} {sys_updated_by=ops.admin} {sys_updated_on=2020-04-24 15:44:26 -0400} {time_zone_pref=-- System Default --} {tw_delay_amount=null} {tw_delay_duration=00:00:00:00} {tw_delay_type=None} {tw_wait_amount=null} {tw_wait_day_constraint=None} {tw_wait_duration=00:00:00:00} {tw_wait_time=00:00} {tw_wait_type=None} {tw_workflow_only=-- System Default --} {type=Windows} {universal_template_id=null} {user_duration=null} {version=4} {wait_for_output=false} ]</after>
                <auditType>Update</auditType>
                <before>TaskWindowsBean [ {agent=094e2a6b2da747d09f4882cdc136dc49} {agent_cluster=null} {agent_cluster_var=null} {agent_cluster_var_check=false} {agent_var=null} {agent_var_check=false} {avg_run_time=null} {broadcast_cluster=null} {broadcast_cluster_var=null} {broadcast_cluster_var_check=false} {checksum=null} {command=echo} {command_or_script=Command} {cp_duration=null} {cp_duration_unit=Minutes} {create_console=false} {credentials=null} {credentials_var=null} {credentials_var_check=false} {custom_field1=null} {custom_field2=null} {desktop_interact=false} {ef_day_constraint=None} {ef_duration=00:00:00:00} {ef_enabled=false} {ef_nth_amount=5} {ef_offset_duration=null} {ef_offset_duration_unit=Minutes} {ef_offset_percentage=0} {ef_offset_type=Percentage} {ef_time=00:00} {ef_type=Time} {elevate_user=false} {environment=null} {exec_counter=0} {execution_restriction=None} {exit_code_output=null} {exit_code_processing=Success Exitcode Range} {exit_code_text=null} {exit_codes=0} {first_run=null} {hold_resources=false} {last_run=null} {last_run_time=null} {lf_day_constraint=None} {lf_duration=00:00:00:00} {lf_enabled=false} {lf_nth_amount=5} {lf_offset_duration=null} {lf_offset_duration_unit=Minutes} {lf_offset_percentage=0} {lf_offset_type=Percentage} {lf_time=00:00} {lf_type=Time} {ls_day_constraint=None} {ls_duration=00:00:00:00} {ls_enabled=false} {ls_nth_amount=5} {ls_time=00:00} {ls_type=Time} {max_run_time=null} {min_run_time=null} {name=test-1} {opswise_groups=null} {output_failure_only=false} {output_return_file=null} {output_return_nline=100} {output_return_sline=1} {output_return_text=null} {output_return_type=NONE} {output_type=STDOUT} {parameters=null} {res_priority=10} {resolve_name_immediately=false} {restriction_period=None} {retry_exit_codes=null} {retry_indefinitely=false} {retry_interval=60} {retry_maximum=0} {retry_suppress_failure=false} {rp_after_date=null} {rp_after_time=null} {rp_before_date=null} {rp_before_time=null} {rp_date_list=null} {run_as_sudo=false} {run_count=0} {run_time=0} {runtime_dir=null} {script=null} {start_held=false} {start_held_reason=null} {summary=test1} {sys_class_name=ops_task_windows} {sys_created_by=ops.admin} {sys_created_on=2020-04-24 15:42:07 -0400} {sys_id=f900ebd674674dbdb3f5499ed20cfecb} {sys_updated_by=ops.admin} {sys_updated_on=2020-04-24 15:42:31 -0400} {time_zone_pref=-- System Default --} {tw_delay_amount=null} {tw_delay_duration=00:00:00:00} {tw_delay_type=None} {tw_wait_amount=null} {tw_wait_day_constraint=None} {tw_wait_duration=00:00:00:00} {tw_wait_time=00:00} {tw_wait_type=None} {tw_workflow_only=-- System Default --} {type=Windows} {universal_template_id=null} {user_duration=null} {version=3} {wait_for_output=false} ]</before>
                <created>2020-04-24 15:44:26 -0400</created>
                <createdBy>ops.admin</createdBy>
                <description>Update: TaskWindowsBean test-1, sys_id: f900ebd674674dbdb3f5499ed20cfecb</description>
                <difference>[Changed command: echo -> echo $] [Changed version: 3 -> 4] </difference>
                <nodeId>SBUS30:8080-opswise1</nodeId>
                <nodeMode>Active</nodeMode>
                <parentAudit>1587757138913023804F2ZFW5HUJ3UQ4</parentAudit>
                <source>User Interface</source>
                <status>Success</status>
                <sysId>1587757138913024804605455IHPYBF9</sysId>
                <tableKey>f900ebd674674dbdb3f5499ed20cfecb</tableKey>
                <tableName>ops_task_windows</tableName>
                <tableRecordName>test-1</tableRecordName>
                <updated>2020-04-24 15:44:26 -0400</updated>
                <updatedBy>ops.admin</updatedBy>
                <uuid>1587757138913024804605455IHPYBF9</uuid>
            </childAudit>
            <childAudit>
                <childAudits/>
                <after>TaskWindowsBean [ {agent=094e2a6b2da747d09f4882cdc136dc49} {agent_cluster=null} {agent_cluster_var=null} {agent_cluster_var_check=false} {agent_var=null} {agent_var_check=false} {avg_run_time=null} {broadcast_cluster=null} {broadcast_cluster_var=null} {broadcast_cluster_var_check=false} {checksum=null} {command=echo $} {command_or_script=Command} {cp_duration=null} {cp_duration_unit=Minutes} {create_console=false} {credentials=null} {credentials_var=null} {credentials_var_check=false} {custom_field1=null} {custom_field2=null} {desktop_interact=false} {ef_day_constraint=None} {ef_duration=00:00:00:00} {ef_enabled=false} {ef_nth_amount=5} {ef_offset_duration=null} {ef_offset_duration_unit=Minutes} {ef_offset_percentage=0} {ef_offset_type=Percentage} {ef_time=00:00} {ef_type=Time} {elevate_user=false} {environment=null} {exec_counter=0} {execution_restriction=None} {exit_code_output=null} {exit_code_processing=Success Exitcode Range} {exit_code_text=null} {exit_codes=0} {first_run=null} {hold_resources=false} {last_run=null} {last_run_time=null} {lf_day_constraint=None} {lf_duration=00:00:00:00} {lf_enabled=false} {lf_nth_amount=5} {lf_offset_duration=null} {lf_offset_duration_unit=Minutes} {lf_offset_percentage=0} {lf_offset_type=Percentage} {lf_time=00:00} {lf_type=Time} {ls_day_constraint=None} {ls_duration=00:00:00:00} {ls_enabled=false} {ls_nth_amount=5} {ls_time=00:00} {ls_type=Time} {max_run_time=null} {min_run_time=null} {name=test-2} {opswise_groups=null} {output_failure_only=false} {output_return_file=null} {output_return_nline=100} {output_return_sline=1} {output_return_text=null} {output_return_type=NONE} {output_type=STDOUT} {parameters=null} {res_priority=10} {resolve_name_immediately=false} {restriction_period=None} {retry_exit_codes=null} {retry_indefinitely=false} {retry_interval=60} {retry_maximum=0} {retry_suppress_failure=false} {rp_after_date=null} {rp_after_time=null} {rp_before_date=null} {rp_before_time=null} {rp_date_list=null} {run_as_sudo=false} {run_count=0} {run_time=0} {runtime_dir=null} {script=null} {start_held=false} {start_held_reason=null} {summary=null} {sys_class_name=ops_task_windows} {sys_created_by=ops.admin} {sys_created_on=2020-04-24 15:43:37 -0400} {sys_id=e9845ee24f804dffb95bdec7bd91888f} {sys_updated_by=ops.admin} {sys_updated_on=2020-04-24 15:44:26 -0400} {time_zone_pref=-- System Default --} {tw_delay_amount=null} {tw_delay_duration=00:00:00:00} {tw_delay_type=None} {tw_wait_amount=null} {tw_wait_day_constraint=None} {tw_wait_duration=00:00:00:00} {tw_wait_time=00:00} {tw_wait_type=None} {tw_workflow_only=-- System Default --} {type=Windows} {universal_template_id=null} {user_duration=null} {version=2} {wait_for_output=false} ]</after>
                <auditType>Update</auditType>
                <before>TaskWindowsBean [ {agent=094e2a6b2da747d09f4882cdc136dc49} {agent_cluster=null} {agent_cluster_var=null} {agent_cluster_var_check=false} {agent_var=null} {agent_var_check=false} {avg_run_time=null} {broadcast_cluster=null} {broadcast_cluster_var=null} {broadcast_cluster_var_check=false} {checksum=null} {command=echo} {command_or_script=Command} {cp_duration=null} {cp_duration_unit=Minutes} {create_console=false} {credentials=null} {credentials_var=null} {credentials_var_check=false} {custom_field1=null} {custom_field2=null} {desktop_interact=false} {ef_day_constraint=None} {ef_duration=00:00:00:00} {ef_enabled=false} {ef_nth_amount=5} {ef_offset_duration=null} {ef_offset_duration_unit=Minutes} {ef_offset_percentage=0} {ef_offset_type=Percentage} {ef_time=00:00} {ef_type=Time} {elevate_user=false} {environment=null} {exec_counter=0} {execution_restriction=None} {exit_code_output=null} {exit_code_processing=Success Exitcode Range} {exit_code_text=null} {exit_codes=0} {first_run=null} {hold_resources=false} {last_run=null} {last_run_time=null} {lf_day_constraint=None} {lf_duration=00:00:00:00} {lf_enabled=false} {lf_nth_amount=5} {lf_offset_duration=null} {lf_offset_duration_unit=Minutes} {lf_offset_percentage=0} {lf_offset_type=Percentage} {lf_time=00:00} {lf_type=Time} {ls_day_constraint=None} {ls_duration=00:00:00:00} {ls_enabled=false} {ls_nth_amount=5} {ls_time=00:00} {ls_type=Time} {max_run_time=null} {min_run_time=null} {name=test-2} {opswise_groups=null} {output_failure_only=false} {output_return_file=null} {output_return_nline=100} {output_return_sline=1} {output_return_text=null} {output_return_type=NONE} {output_type=STDOUT} {parameters=null} {res_priority=10} {resolve_name_immediately=false} {restriction_period=None} {retry_exit_codes=null} {retry_indefinitely=false} {retry_interval=60} {retry_maximum=0} {retry_suppress_failure=false} {rp_after_date=null} {rp_after_time=null} {rp_before_date=null} {rp_before_time=null} {rp_date_list=null} {run_as_sudo=false} {run_count=0} {run_time=0} {runtime_dir=null} {script=null} {start_held=false} {start_held_reason=null} {summary=null} {sys_class_name=ops_task_windows} {sys_created_by=ops.admin} {sys_created_on=2020-04-24 15:43:37 -0400} {sys_id=e9845ee24f804dffb95bdec7bd91888f} {sys_updated_by=ops.admin} {sys_updated_on=2020-04-24 15:43:37 -0400} {time_zone_pref=-- System Default --} {tw_delay_amount=null} {tw_delay_duration=00:00:00:00} {tw_delay_type=None} {tw_wait_amount=null} {tw_wait_day_constraint=None} {tw_wait_duration=00:00:00:00} {tw_wait_time=00:00} {tw_wait_type=None} {tw_workflow_only=-- System Default --} {type=Windows} {universal_template_id=null} {user_duration=null} {version=1} {wait_for_output=false} ]</before>
                <created>2020-04-24 15:44:26 -0400</created>
                <createdBy>ops.admin</createdBy>
                <description>Update: TaskWindowsBean test-2, sys_id: e9845ee24f804dffb95bdec7bd91888f</description>
                <difference>[Changed command: echo -> echo $] [Changed version: 1 -> 2] </difference>
                <nodeId>SBUS30:8080-opswise1</nodeId>
                <nodeMode>Active</nodeMode>
                <parentAudit>1587757138913023804F2ZFW5HUJ3UQ4</parentAudit>
                <source>User Interface</source>
                <status>Success</status>
                <sysId>1587757138913025804IFKIQTGM93GHB</sysId>
                <tableKey>e9845ee24f804dffb95bdec7bd91888f</tableKey>
                <tableName>ops_task_windows</tableName>
                <tableRecordName>test-2</tableRecordName>
                <updated>2020-04-24 15:44:26 -0400</updated>
                <updatedBy>ops.admin</updatedBy>
                <uuid>1587757138913025804IFKIQTGM93GHB</uuid>
            </childAudit>
        </childAudits>
        <additionalInfo>Ids: [f900ebd674674dbdb3f5499ed20cfecb, e9845ee24f804dffb95bdec7bd91888f]
 
Changes:
    {command=echo $}
 
Multi-Update: Successfully updated all 2 items
</additionalInfo>
        <auditType>Update</auditType>
        <created>2020-04-24 15:44:26 -0400</created>
        <createdBy>ops.admin</createdBy>
        <description>Multiple-Update by Selection of TaskWindowsBean</description>
        <nodeId>SBUS30:8080-opswise1</nodeId>
        <nodeMode>Active</nodeMode>
        <source>User Interface</source>
        <status>Success</status>
        <sysId>1587757138913023804F2ZFW5HUJ3UQ4</sysId>
        <tableName>ops_task_windows</tableName>
        <updated>2020-04-24 15:44:26 -0400</updated>
        <updatedBy>ops.admin</updatedBy>
        <uuid>1587757138913023804F2ZFW5HUJ3UQ4</uuid>
    </audit>

Expand
titleXML
Expand
titleJSON
[
 {
    "additionalInfo": "Ids: [f900ebd674674dbdb3f5499ed20cfecb, e9845ee24f804dffb95bdec7bd91888f]\n\nChanges:\n    {command=echo $}\n\nMulti-Update: Successfully updated all 2 items\n",
    "after": null,
    "auditType": "Update",
    "before": null,
    "childAudits": [
      {
        "additionalInfo": null,
        "after": "TaskWindowsBean [ {agent=094e2a6b2da747d09f4882cdc136dc49} {agent_cluster=null} {agent_cluster_var=null} {agent_cluster_var_check=false} {agent_var=null} {agent_var_check=false} {avg_run_time=null} {broadcast_cluster=null} {broadcast_cluster_var=null} {broadcast_cluster_var_check=false} {checksum=null} {command=echo $} {command_or_script=Command} {cp_duration=null} {cp_duration_unit=Minutes} {create_console=false} {credentials=null} {credentials_var=null} {credentials_var_check=false} {custom_field1=null} {custom_field2=null} {desktop_interact=false} {ef_day_constraint=None} {ef_duration=00:00:00:00} {ef_enabled=false} {ef_nth_amount=5} {ef_offset_duration=null} {ef_offset_duration_unit=Minutes} {ef_offset_percentage=0} {ef_offset_type=Percentage} {ef_time=00:00} {ef_type=Time} {elevate_user=false} {environment=null} {exec_counter=0} {execution_restriction=None} {exit_code_output=null} {exit_code_processing=Success Exitcode Range} {exit_code_text=null} {exit_codes=0} {first_run=null} {hold_resources=false} {last_run=null} {last_run_time=null} {lf_day_constraint=None} {lf_duration=00:00:00:00} {lf_enabled=false} {lf_nth_amount=5} {lf_offset_duration=null} {lf_offset_duration_unit=Minutes} {lf_offset_percentage=0} {lf_offset_type=Percentage} {lf_time=00:00} {lf_type=Time} {ls_day_constraint=None} {ls_duration=00:00:00:00} {ls_enabled=false} {ls_nth_amount=5} {ls_time=00:00} {ls_type=Time} {max_run_time=null} {min_run_time=null} {name=test-1} {opswise_groups=null} {output_failure_only=false} {output_return_file=null} {output_return_nline=100} {output_return_sline=1} {output_return_text=null} {output_return_type=NONE} {output_type=STDOUT} {parameters=null} {res_priority=10} {resolve_name_immediately=false} {restriction_period=None} {retry_exit_codes=null} {retry_indefinitely=false} {retry_interval=60} {retry_maximum=0} {retry_suppress_failure=false} {rp_after_date=null} {rp_after_time=null} {rp_before_date=null} {rp_before_time=null} {rp_date_list=null} {run_as_sudo=false} {run_count=0} {run_time=0} {runtime_dir=null} {script=null} {start_held=false} {start_held_reason=null} {summary=test1} {sys_class_name=ops_task_windows} {sys_created_by=ops.admin} {sys_created_on=2020-04-24 15:42:07 -0400} {sys_id=f900ebd674674dbdb3f5499ed20cfecb} {sys_updated_by=ops.admin} {sys_updated_on=2020-04-24 15:44:26 -0400} {time_zone_pref=-- System Default --} {tw_delay_amount=null} {tw_delay_duration=00:00:00:00} {tw_delay_type=None} {tw_wait_amount=null} {tw_wait_day_constraint=None} {tw_wait_duration=00:00:00:00} {tw_wait_time=00:00} {tw_wait_type=None} {tw_workflow_only=-- System Default --} {type=Windows} {universal_template_id=null} {user_duration=null} {version=4} {wait_for_output=false} ]",
        "auditType": "Update",
        "before": "TaskWindowsBean [ {agent=094e2a6b2da747d09f4882cdc136dc49} {agent_cluster=null} {agent_cluster_var=null} {agent_cluster_var_check=false} {agent_var=null} {agent_var_check=false} {avg_run_time=null} {broadcast_cluster=null} {broadcast_cluster_var=null} {broadcast_cluster_var_check=false} {checksum=null} {command=echo} {command_or_script=Command} {cp_duration=null} {cp_duration_unit=Minutes} {create_console=false} {credentials=null} {credentials_var=null} {credentials_var_check=false} {custom_field1=null} {custom_field2=null} {desktop_interact=false} {ef_day_constraint=None} {ef_duration=00:00:00:00} {ef_enabled=false} {ef_nth_amount=5} {ef_offset_duration=null} {ef_offset_duration_unit=Minutes} {ef_offset_percentage=0} {ef_offset_type=Percentage} {ef_time=00:00} {ef_type=Time} {elevate_user=false} {environment=null} {exec_counter=0} {execution_restriction=None} {exit_code_output=null} {exit_code_processing=Success Exitcode Range} {exit_code_text=null} {exit_codes=0} {first_run=null} {hold_resources=false} {last_run=null} {last_run_time=null} {lf_day_constraint=None} {lf_duration=00:00:00:00} {lf_enabled=false} {lf_nth_amount=5} {lf_offset_duration=null} {lf_offset_duration_unit=Minutes} {lf_offset_percentage=0} {lf_offset_type=Percentage} {lf_time=00:00} {lf_type=Time} {ls_day_constraint=None} {ls_duration=00:00:00:00} {ls_enabled=false} {ls_nth_amount=5} {ls_time=00:00} {ls_type=Time} {max_run_time=null} {min_run_time=null} {name=test-1} {opswise_groups=null} {output_failure_only=false} {output_return_file=null} {output_return_nline=100} {output_return_sline=1} {output_return_text=null} {output_return_type=NONE} {output_type=STDOUT} {parameters=null} {res_priority=10} {resolve_name_immediately=false} {restriction_period=None} {retry_exit_codes=null} {retry_indefinitely=false} {retry_interval=60} {retry_maximum=0} {retry_suppress_failure=false} {rp_after_date=null} {rp_after_time=null} {rp_before_date=null} {rp_before_time=null} {rp_date_list=null} {run_as_sudo=false} {run_count=0} {run_time=0} {runtime_dir=null} {script=null} {start_held=false} {start_held_reason=null} {summary=test1} {sys_class_name=ops_task_windows} {sys_created_by=ops.admin} {sys_created_on=2020-04-24 15:42:07 -0400} {sys_id=f900ebd674674dbdb3f5499ed20cfecb} {sys_updated_by=ops.admin} {sys_updated_on=2020-04-24 15:42:31 -0400} {time_zone_pref=-- System Default --} {tw_delay_amount=null} {tw_delay_duration=00:00:00:00} {tw_delay_type=None} {tw_wait_amount=null} {tw_wait_day_constraint=None} {tw_wait_duration=00:00:00:00} {tw_wait_time=00:00} {tw_wait_type=None} {tw_workflow_only=-- System Default --} {type=Windows} {universal_template_id=null} {user_duration=null} {version=3} {wait_for_output=false} ]",
        "childAudits": [],
        "created": "2020-04-24 15:44:26 -0400",
        "createdBy": "ops.admin",
        "description": "Update: TaskWindowsBean test-1, sys_id: f900ebd674674dbdb3f5499ed20cfecb",
        "difference": "[Changed command: echo -> echo $] [Changed version: 3 -> 4] ",
        "nodeId": "SBUS30:8080-opswise1",
        "nodeMode": "Active",
        "parentAudit": "1587757138913023804F2ZFW5HUJ3UQ4",
        "routedFrom": null,
        "source": "User Interface",
        "status": "Success",
        "sysId": "1587757138913024804605455IHPYBF9",
        "tableKey": "f900ebd674674dbdb3f5499ed20cfecb",
        "tableName": "ops_task_windows",
        "tableRecordName": "test-1",
        "universalTemplate": null,
        "updated": "2020-04-24 15:44:26 -0400",
        "updatedBy": "ops.admin",
        "uuid": "1587757138913024804605455IHPYBF9"
      },
      {
        "additionalInfo": null,
        "after": "TaskWindowsBean [ {agent=094e2a6b2da747d09f4882cdc136dc49} {agent_cluster=null} {agent_cluster_var=null} {agent_cluster_var_check=false} {agent_var=null} {agent_var_check=false} {avg_run_time=null} {broadcast_cluster=null} {broadcast_cluster_var=null} {broadcast_cluster_var_check=false} {checksum=null} {command=echo $} {command_or_script=Command} {cp_duration=null} {cp_duration_unit=Minutes} {create_console=false} {credentials=null} {credentials_var=null} {credentials_var_check=false} {custom_field1=null} {custom_field2=null} {desktop_interact=false} {ef_day_constraint=None} {ef_duration=00:00:00:00} {ef_enabled=false} {ef_nth_amount=5} {ef_offset_duration=null} {ef_offset_duration_unit=Minutes} {ef_offset_percentage=0} {ef_offset_type=Percentage} {ef_time=00:00} {ef_type=Time} {elevate_user=false} {environment=null} {exec_counter=0} {execution_restriction=None} {exit_code_output=null} {exit_code_processing=Success Exitcode Range} {exit_code_text=null} {exit_codes=0} {first_run=null} {hold_resources=false} {last_run=null} {last_run_time=null} {lf_day_constraint=None} {lf_duration=00:00:00:00} {lf_enabled=false} {lf_nth_amount=5} {lf_offset_duration=null} {lf_offset_duration_unit=Minutes} {lf_offset_percentage=0} {lf_offset_type=Percentage} {lf_time=00:00} {lf_type=Time} {ls_day_constraint=None} {ls_duration=00:00:00:00} {ls_enabled=false} {ls_nth_amount=5} {ls_time=00:00} {ls_type=Time} {max_run_time=null} {min_run_time=null} {name=test-2} {opswise_groups=null} {output_failure_only=false} {output_return_file=null} {output_return_nline=100} {output_return_sline=1} {output_return_text=null} {output_return_type=NONE} {output_type=STDOUT} {parameters=null} {res_priority=10} {resolve_name_immediately=false} {restriction_period=None} {retry_exit_codes=null} {retry_indefinitely=false} {retry_interval=60} {retry_maximum=0} {retry_suppress_failure=false} {rp_after_date=null} {rp_after_time=null} {rp_before_date=null} {rp_before_time=null} {rp_date_list=null} {run_as_sudo=false} {run_count=0} {run_time=0} {runtime_dir=null} {script=null} {start_held=false} {start_held_reason=null} {summary=null} {sys_class_name=ops_task_windows} {sys_created_by=ops.admin} {sys_created_on=2020-04-24 15:43:37 -0400} {sys_id=e9845ee24f804dffb95bdec7bd91888f} {sys_updated_by=ops.admin} {sys_updated_on=2020-04-24 15:44:26 -0400} {time_zone_pref=-- System Default --} {tw_delay_amount=null} {tw_delay_duration=00:00:00:00} {tw_delay_type=None} {tw_wait_amount=null} {tw_wait_day_constraint=None} {tw_wait_duration=00:00:00:00} {tw_wait_time=00:00} {tw_wait_type=None} {tw_workflow_only=-- System Default --} {type=Windows} {universal_template_id=null} {user_duration=null} {version=2} {wait_for_output=false} ]",
        "auditType": "Update",
        "before": "TaskWindowsBean [ {agent=094e2a6b2da747d09f4882cdc136dc49} {agent_cluster=null} {agent_cluster_var=null} {agent_cluster_var_check=false} {agent_var=null} {agent_var_check=false} {avg_run_time=null} {broadcast_cluster=null} {broadcast_cluster_var=null} {broadcast_cluster_var_check=false} {checksum=null} {command=echo} {command_or_script=Command} {cp_duration=null} {cp_duration_unit=Minutes} {create_console=false} {credentials=null} {credentials_var=null} {credentials_var_check=false} {custom_field1=null} {custom_field2=null} {desktop_interact=false} {ef_day_constraint=None} {ef_duration=00:00:00:00} {ef_enabled=false} {ef_nth_amount=5} {ef_offset_duration=null} {ef_offset_duration_unit=Minutes} {ef_offset_percentage=0} {ef_offset_type=Percentage} {ef_time=00:00} {ef_type=Time} {elevate_user=false} {environment=null} {exec_counter=0} {execution_restriction=None} {exit_code_output=null} {exit_code_processing=Success Exitcode Range} {exit_code_text=null} {exit_codes=0} {first_run=null} {hold_resources=false} {last_run=null} {last_run_time=null} {lf_day_constraint=None} {lf_duration=00:00:00:00} {lf_enabled=false} {lf_nth_amount=5} {lf_offset_duration=null} {lf_offset_duration_unit=Minutes} {lf_offset_percentage=0} {lf_offset_type=Percentage} {lf_time=00:00} {lf_type=Time} {ls_day_constraint=None} {ls_duration=00:00:00:00} {ls_enabled=false} {ls_nth_amount=5} {ls_time=00:00} {ls_type=Time} {max_run_time=null} {min_run_time=null} {name=test-2} {opswise_groups=null} {output_failure_only=false} {output_return_file=null} {output_return_nline=100} {output_return_sline=1} {output_return_text=null} {output_return_type=NONE} {output_type=STDOUT} {parameters=null} {res_priority=10} {resolve_name_immediately=false} {restriction_period=None} {retry_exit_codes=null} {retry_indefinitely=false} {retry_interval=60} {retry_maximum=0} {retry_suppress_failure=false} {rp_after_date=null} {rp_after_time=null} {rp_before_date=null} {rp_before_time=null} {rp_date_list=null} {run_as_sudo=false} {run_count=0} {run_time=0} {runtime_dir=null} {script=null} {start_held=false} {start_held_reason=null} {summary=null} {sys_class_name=ops_task_windows} {sys_created_by=ops.admin} {sys_created_on=2020-04-24 15:43:37 -0400} {sys_id=e9845ee24f804dffb95bdec7bd91888f} {sys_updated_by=ops.admin} {sys_updated_on=2020-04-24 15:43:37 -0400} {time_zone_pref=-- System Default --} {tw_delay_amount=null} {tw_delay_duration=00:00:00:00} {tw_delay_type=None} {tw_wait_amount=null} {tw_wait_day_constraint=None} {tw_wait_duration=00:00:00:00} {tw_wait_time=00:00} {tw_wait_type=None} {tw_workflow_only=-- System Default --} {type=Windows} {universal_template_id=null} {user_duration=null} {version=1} {wait_for_output=false} ]",
        "childAudits": [],
        "created": "2020-04-24 15:44:26 -0400",
        "createdBy": "ops.admin",
        "description": "Update: TaskWindowsBean test-2, sys_id: e9845ee24f804dffb95bdec7bd91888f",
        "difference": "[Changed command: echo -> echo $] [Changed version: 1 -> 2] ",
        "nodeId": "SBUS30:8080-opswise1",
        "nodeMode": "Active",
        "parentAudit": "1587757138913023804F2ZFW5HUJ3UQ4",
        "routedFrom": null,
        "source": "User Interface",
        "status": "Success",
        "sysId": "1587757138913025804IFKIQTGM93GHB",
        "tableKey": "e9845ee24f804dffb95bdec7bd91888f",
        "tableName": "ops_task_windows",
        "tableRecordName": "test-2",
        "universalTemplate": null,
        "updated": "2020-04-24 15:44:26 -0400",
        "updatedBy": "ops.admin",
        "uuid": "1587757138913025804IFKIQTGM93GHB"
      }
    ],
    "created": "2020-04-24 15:44:26 -0400",
    "createdBy": "ops.admin",
    "description": "Multiple-Update by Selection of TaskWindowsBean",
    "difference": null,
    "nodeId": "SBUS30:8080-opswise1",
    "nodeMode": "Active",
    "parentAudit": null,
    "routedFrom": null,
    "source": "User Interface",
    "status": "Success",
    "sysId": "1587757138913023804F2ZFW5HUJ3UQ4",
    "tableKey": null,
    "tableName": "ops_task_windows",
    "tableRecordName": null,
    "universalTemplate": null,
    "updated": "2020-04-24 15:44:26 -0400",
    "updatedBy": "ops.admin",
    "uuid": "1587757138913023804F2ZFW5HUJ3UQ4"
  }
 ]
{
	"name": "ExampleEvent", <attribute>
     "businessServices": [
      "BusinessServiceName1",
      "BusinessServiceName2"
    ],
	"ttl": 60,
	"attributes": [
		{
			"name": "example_attribute1",
			"value": "Value1"
		},
		{
			"name": "example_attribute2",
			"value": "Value2"
		}
	]
}

List Audit Records: Request Properties

...

Property

...

UI Field Name

...

Description

...

Specifications

...

Required

...

Valid values: One of the following (not case sensitive):

  • As String = Create, As Value = 1
  • As String = Update, As Value = 2
  • As String = Delete, As Value = 3
  • As String = Command, As Value = 4
  • As String = Server Operation, As Value = 5
  • As String = CLI, As Value = 6
  • As String = Restore Version, As Value = 7
  • As String = Delete Version, As Value = 8
  • As String = User Login, As Value = 9
  • As String = z/OS Auto-Restart, As Value = 10
  • As String = Delete Override File, As Value = 11
  • As String = Import, As Value = 12
  • As String = Export, As Value = 13
  • As String = Email, As Value = 14

...

 <name>example_attribute2</name>
      <value>Value2</value>
    </attribute>
  </attributes>
</universalEvent>
Expand
titleJSON
{
   "name": "ExampleEvent",
   "businessServices": [
      "BusinessServiceName1",
      "BusinessServiceName2"
    ],
    "ttl": 60,
    "attributes": [
       {
          "name": "example_attribute1",
          "value": "Value1"
       },
       {
          "name": "example_attribute2",
          "value": "Value2"
       }
    ]
}