Skip to main content

Audit Web Services

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

Users with the ops_admin role or ops_audit_view role can use Audit Web Services for all Audit records.

If Audit Owner Read Permitted system property = true, users without either the ops_admin role or the ops_audit_view role can use Audit Web Services to view their own audits.

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

List Audit Records​

Description

URI

http://host_name/uc/resources/audit/list

Description

Retrieve the audit details using a specific filter.

HTTP Method

POST

Example URI

http://localhost:8080/uc/resources/audit/list

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

List Audit Records: XML and JSON Examples​

List Audit Records: Example Request​

JSON
JSON
{
    "auditType": "9",
    "updatedTimeType": "offset",
    "updatedTime": "-10d",
    "status": "*",
    "createdBy": "ops.system",
    "tableRecordName": "Administrator",
    "tableName": "ops_user",
    "source": "Web Service",
    "tableKey": "51b13fca5b8541418cd17cdd97c95b87",
    "includeChildAudits": "false"
}

List Audit Records: Request Properties​

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

auditType

Audit Type

Audit type to filter the data.

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

N

source

Source

Audit source type

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

N

updatedTime

n/a

If updatedTimeType = Offset; -offset period.

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.

Y
(if updatedTimeType
is Offset, Since,
or Older Than.)

updatedTimeType

n/a

Type of updateTime.

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

N

createdBy

Created By

Name of the person created the record.

N

status

Status

Status of the record

N

tableRecordName

Table Record Name

table record name

N

tableName

Table Name

table name

N

tableKey

Table Key

table key

N

includeChildAudits

n/a

include child audits

boolean property

Valid values: true, false, 1, 0

N

List Audit Records: Example Response​

JSON
JSON
[
    {
        "additionalInfo": "Web Service '/audit/list' invoked from IP address 192.168.31.236.",
        "after": null,
        "auditType": "User Login",
        "before": null,
        "childAudits": [],
        "created": "2022-02-16 11:40:02 -0500",
        "createdBy": "ops.system",
        "description": "LOGIN <user=ops.admin, ipaddr=192.168.31.236>",
        "difference": null,
        "nodeId": "qa-cntlr-mssql:8080-qa_cntlr_mssql",
        "nodeMode": "Active",
        "parentAudit": null,
        "routedFrom": null,
        "source": "Web Service",
        "status": "Login OK",
        "sysId": "1644956665138213147585IXHF9ZIY0B",
        "tableKey": "e0bde364c0a802ba0092e79554132023",
        "tableName": "ops_user",
        "tableRecordName": "Administrator",
        "universalTemplate": null,
        "updated": "2022-02-16 11:40:02 -0500",
        "updatedBy": "ops.system",
        "uuid": "1644956665138213147585IXHF9ZIY0B"
    },
    {
        "additionalInfo": "Web Service '/audit/list' invoked from IP address 192.168.31.236.",
        "after": null,
        "auditType": "User Login",
        "before": null,
        "childAudits": [],
        "created": "2022-02-16 11:36:54 -0500",
        "createdBy": "ops.system",
        "description": "LOGIN <user=ops.admin, ipaddr=192.168.31.236>",
        "difference": null,
        "nodeId": "qa-cntlr-mssql:8080-qa_cntlr_mssql",
        "nodeMode": "Active",
        "parentAudit": null,
        "routedFrom": null,
        "source": "Web Service",
        "status": "Login OK",
        "sysId": "16449566651382121473A4USED0CVKOC",
        "tableKey": "e0bde364c0a802ba0092e79554132023",
        "tableName": "ops_user",
        "tableRecordName": "Administrator",
        "universalTemplate": null,
        "updated": "2022-02-16 11:36:54 -0500",
        "updatedBy": "ops.system",
        "uuid": "16449566651382121473A4USED0CVKOC"
    }, 
    {
        "additionalInfo": "Web Service '/audit/list' invoked from IP address 192.168.31.236.",
        "after": null,
        "auditType": "User Login",
        "before": null,
        "childAudits": [],
        "created": "2022-02-16 11:36:25 -0500",
        "createdBy": "ops.system",
        "description": "LOGIN <user=ops.admin, ipaddr=192.168.31.236>",
        "difference": null,
        "nodeId": "qa-cntlr-mssql:8080-qa_cntlr_mssql",
        "nodeMode": "Active",
        "parentAudit": null,
        "routedFrom": null,
        "source": "Web Service",
        "status": "Login OK",
        "sysId": "16449566651382111478QX9WBBDPE6LS",
        "tableKey": "e0bde364c0a802ba0092e79554132023",
        "tableName": "ops_user",
        "tableRecordName": "Administrator",
        "universalTemplate": null,
        "updated": "2022-02-16 11:36:25 -0500",
        "updatedBy": "ops.system",
        "uuid": "16449566651382111478QX9WBBDPE6LS"
    },
]

List Audit Records: Example Response with Child Audits​

JSON
JSON
[
 {
    "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"
  }
 ]