Search Knowledge Base by Keyword
Audit Logs
Endpoints for getting Event Log information. Endpoints include:
auditLogs/login | Get the login history. | |
auditLogs/system | Get all logged system events. | |
auditLogs/tcomm | Get the T-Comm history. | |
auditLogs/etl5 | Get the ETL5 Job logs. |
auditLogs/login Get ‘Login Events’ Logs.
The endpoint has an optional JSON Body Payload containing five parameters:
- page = Integer [1 – Default Page 1]
- The page you want to show
- page_length = Integer [10 – Default 10 Records Per Page]
- The amount of entries to show for each page
- start_date = String Date Format (YYYY-MM-DD)
- Entries after this date will show
- end_date = String Date Format (YYYY-MM-DD)
- Entries before this date will show
- order_by = String [“asc”, “desc” – Default is descending]
- Optional parameter to order by ascending or descending timestamp
Payload Example:
{ "page": "1", "page_length": "10", "start_date": "2021-04-09", "end_date": "2021-05-13", "order_by": "desc" } |
Example discovery result for auditLogs/login:
{ "recordsTotal": 2212, "recordsFiltered": 7, "data": [ { "timestamp": "2024-10-04 12:53:47", "email": "admin@readyworks.com", "first_name": "ReadyWorks", "last_name": "Admin", "security_group": "Administrator", "ip_address": "::1", "user_id": "14", "login_date_formatted": "2024-10-04 12:53:47" }, { "timestamp": "2024-10-03 09:25:28", "email": "admin@readyworks.com", "first_name": "ReadyWorks", "last_name": "Admin", "security_group": "Administrator", "ip_address": "::1", "user_id": "14", "login_date_formatted": "2024-10-03 09:25:28" }, { "timestamp": "2024-10-02 19:02:17", "email": "admin@readyworks.com", "first_name": "ReadyWorks", "last_name": "Admin", "security_group": "Administrator", "ip_address": "::1", "user_id": "14", "login_date_formatted": "2024-10-02 19:02:17" }, { "timestamp": "2024-10-02 17:55:33", "email": "admin@readyworks.com", "first_name": "ReadyWorks", "last_name": "Admin", "security_group": "Administrator", "ip_address": "::1", "user_id": "14", "login_date_formatted": "2024-10-02 17:55:33" }, { "timestamp": "2024-10-02 12:43:07", "email": "admin@readyworks.com", "first_name": "ReadyWorks", "last_name": "Admin", "security_group": "Administrator", "ip_address": "::1", "user_id": "14", "login_date_formatted": "2024-10-02 12:43:07" }, { "timestamp": "2024-10-02 10:08:00", "email": "admin@readyworks.com", "first_name": "ReadyWorks", "last_name": "Admin", "security_group": "Administrator", "ip_address": "::1", "user_id": "14", "login_date_formatted": "2024-10-02 10:08:00" }, { "timestamp": "2024-10-01 09:58:54", "email": "admin@readyworks.com", "first_name": "ReadyWorks", "last_name": "Admin", "security_group": "Administrator", "ip_address": "::1", "user_id": "14", "login_date_formatted": "2024-10-01 09:58:54" } ] } |
The discovery pull provides:
- recordsTotal = total number of records
- recordsFiltered = number of records filtered by date range
- data = record data for the currently selected page
URL: https://webroot/api/v1/auditLogs/login
Parameters
Name | Description |
Authorization string (header)
* required
|
Default value: Bearer {token}
|
Body (body)
|
Example Value
|
application/json
|
|
{ "page": "1", "page_length": "10", "start_date": "2024-10-01", "end_date": "2024-10-07", "order_by": "desc" } |
|
Model |
|
Responses
Code | Description |
200
|
Example Value |
application/json | |
{ "recordsTotal": 2212, "recordsFiltered": 7, "data": [ { "timestamp": "2024-10-04 12:53:47", "email": "admin@readyworks.com", "first_name": "ReadyWorks", "last_name": "Admin", "security_group": "Administrator", "ip_address": "::1", "user_id": "14", "login_date_formatted": "2024-10-04 12:53:47" }, { "timestamp": "2024-10-03 09:25:28", "email": "admin@readyworks.com", "first_name": "ReadyWorks", "last_name": "Admin", "security_group": "Administrator", "ip_address": "::1", "user_id": "14", "login_date_formatted": "2024-10-03 09:25:28" }, { "timestamp": "2024-10-02 19:02:17", "email": "admin@readyworks.com", "first_name": "ReadyWorks", "last_name": "Admin", "security_group": "Administrator", "ip_address": "::1", "user_id": "14", "login_date_formatted": "2024-10-02 19:02:17" }, { "timestamp": "2024-10-02 17:55:33", "email": "admin@readyworks.com", "first_name": "ReadyWorks", "last_name": "Admin", "security_group": "Administrator", "ip_address": "::1", "user_id": "14", "login_date_formatted": "2024-10-02 17:55:33" }, { "timestamp": "2024-10-02 12:43:07", "email": "admin@readyworks.com", "first_name": "ReadyWorks", "last_name": "Admin", "security_group": "Administrator", "ip_address": "::1", "user_id": "14", "login_date_formatted": "2024-10-02 12:43:07" }, { "timestamp": "2024-10-02 10:08:00", "email": "admin@readyworks.com", "first_name": "ReadyWorks", "last_name": "Admin", "security_group": "Administrator", "ip_address": "::1", "user_id": "14", "login_date_formatted": "2024-10-02 10:08:00" }, { "timestamp": "2024-10-01 09:58:54", "email": "admin@readyworks.com", "first_name": "ReadyWorks", "last_name": "Admin", "security_group": "Administrator", "ip_address": "::1", "user_id": "14", "login_date_formatted": "2024-10-01 09:58:54" } ] } |
|
Model |
|
Headers
Name | Type |
Date | string |
Server | string |
X-Powered-By | string |
Content-Length | string |
Keep-Alive | string |
Connection | string |
auditLogs/system Get ‘System Events’ Logs.
The endpoint has an optional JSON Body Payload containing five parameters:
- page = Integer [1 – Default Page 1]
- The page you want to show
- page_length = Integer [10 – Default 10 Records Per Page]
- The amount of entries to show for each page
- start_date = String Date Format (YYYY-MM-DD)
- Entries after this date will show
- end_date = String Date Format (YYYY-MM-DD)
- Entries before this date will show
- order_by = String [“asc”, “desc” – Default is descending]
- Optional parameter to order by ascending or descending timestamp
Payload Example:
{ "page": "1", "page_length": "5", "start_date": "2024-09-04", "end_date": "2024-09-05", "order_by": "desc" } |
Example discovery result for auditLogs/system:
{ "recordsTotal": 114957, "recordsFiltered": 38, "data": [ { "timestamp": "2024-09-04 14:49:53", "user_name": "ReadyWorks Admin", "ip_address": "::1", "action": "CREATE", "title": "Created ETL Views", "details": "Created ETL Views", "item_module": "ETL Views", "item_name": "ETL Views", "link_module": null, "link_name": null, "item_url": "manager.php?p=adminlogs", "link_url": null, "admin_id": "14", "timestamp_formatted": "2024-09-04 14:49:53" }, { "timestamp": "2024-09-04 14:49:53", "user_name": "ReadyWorks Admin", "ip_address": "::1", "action": "DELETE", "title": "Deleted ETL Views", "details": "Deleted ETL Views", "item_module": "ETL Views", "item_name": "ETL Views", "link_module": null, "link_name": null, "item_url": "manager.php?p=adminlogs", "link_url": null, "admin_id": "14", "timestamp_formatted": "2024-09-04 14:49:53" }, { "timestamp": "2024-09-04 13:38:44", "user_name": "ReadyWorks Admin", "ip_address": "::1", "action": "UPDATE", "title": "Updated [Data Mapping] named [1Test]", "details": "Add Helper Query named [Query 3]\n", "item_module": "Data Mapping", "item_name": "1Test", "link_module": null, "link_name": null, "item_url": "manager.php?p=edit_mapping&id=56", "link_url": null, "admin_id": "14", "timestamp_formatted": "2024-09-04 13:38:44" }, { "timestamp": "2024-09-04 13:38:33", "user_name": "ReadyWorks Admin", "ip_address": "::1", "action": "UPDATE", "title": "Updated [Data Mapping] named [1Test]", "details": "Add Helper Query named [Query 2]\n", "item_module": "Data Mapping", "item_name": "1Test", "link_module": null, "link_name": null, "item_url": "manager.php?p=edit_mapping&id=56", "link_url": null, "admin_id": "14", "timestamp_formatted": "2024-09-04 13:38:33" }, { "timestamp": "2024-09-04 13:38:24", "user_name": "ReadyWorks Admin", "ip_address": "::1", "action": "UPDATE", "title": "Updated [Data Mapping] named [1Test]", "details": "Add Main Query named [Main Query]", "item_module": "Data Mapping", "item_name": "1Test", "link_module": null, "link_name": null, "item_url": "manager.php?p=edit_mapping&id=56", "link_url": null, "admin_id": "14", "timestamp_formatted": "2024-09-04 13:38:24" } ] } |
The discovery pull provides:
- recordsTotal = total number of records
- recordsFiltered = number of records filtered by date range
- data = record data for the currently selected page
URL: https://webroot/api/v1/auditLogs/system
Parameters
Name | Description |
Authorization string (header)
* required
|
Default value: Bearer {token}
|
Body (body)
|
Example Value
|
application/json
|
|
{ "page": "1", "page_length": "5", "start_date": "2024-09-04", "end_date": "2024-09-05", "order_by": "desc" } |
|
Model |
|
Responses
Code | Description |
200
|
Example Value |
application/json | |
{ "recordsTotal": 114957, "recordsFiltered": 38, "data": [ { "timestamp": "2024-09-04 14:49:53", "user_name": "ReadyWorks Admin", "ip_address": "::1", "action": "CREATE", "title": "Created ETL Views", "details": "Created ETL Views", "item_module": "ETL Views", "item_name": "ETL Views", "link_module": null, "link_name": null, "item_url": "manager.php?p=adminlogs", "link_url": null, "admin_id": "14", "timestamp_formatted": "2024-09-04 14:49:53" }, { "timestamp": "2024-09-04 14:49:53", "user_name": "ReadyWorks Admin", "ip_address": "::1", "action": "DELETE", "title": "Deleted ETL Views", "details": "Deleted ETL Views", "item_module": "ETL Views", "item_name": "ETL Views", "link_module": null, "link_name": null, "item_url": "manager.php?p=adminlogs", "link_url": null, "admin_id": "14", "timestamp_formatted": "2024-09-04 14:49:53" }, { "timestamp": "2024-09-04 13:38:44", "user_name": "ReadyWorks Admin", "ip_address": "::1", "action": "UPDATE", "title": "Updated [Data Mapping] named [1Test]", "details": "Add Helper Query named [Query 3]\n", "item_module": "Data Mapping", "item_name": "1Test", "link_module": null, "link_name": null, "item_url": "manager.php?p=edit_mapping&id=56", "link_url": null, "admin_id": "14", "timestamp_formatted": "2024-09-04 13:38:44" }, { "timestamp": "2024-09-04 13:38:33", "user_name": "ReadyWorks Admin", "ip_address": "::1", "action": "UPDATE", "title": "Updated [Data Mapping] named [1Test]", "details": "Add Helper Query named [Query 2]\n", "item_module": "Data Mapping", "item_name": "1Test", "link_module": null, "link_name": null, "item_url": "manager.php?p=edit_mapping&id=56", "link_url": null, "admin_id": "14", "timestamp_formatted": "2024-09-04 13:38:33" }, { "timestamp": "2024-09-04 13:38:24", "user_name": "ReadyWorks Admin", "ip_address": "::1", "action": "UPDATE", "title": "Updated [Data Mapping] named [1Test]", "details": "Add Main Query named [Main Query]", "item_module": "Data Mapping", "item_name": "1Test", "link_module": null, "link_name": null, "item_url": "manager.php?p=edit_mapping&id=56", "link_url": null, "admin_id": "14", "timestamp_formatted": "2024-09-04 13:38:24" } ] } |
|
Model |
|
Headers
Name | Type |
Date | string |
Server | string |
X-Powered-By | string |
Content-Length | string |
Keep-Alive | string |
Connection | string |
auditLogs/tcomm Get ‘T-Comm Events’ Logs.
The endpoint has an optional JSON Body Payload containing five parameters:
- page = Integer [1 – Default Page 1]
- The page you want to show
- page_length = Integer [10 – Default 10 Records Per Page]
- The amount of entries to show for each page
- start_date = String Date Format (YYYY-MM-DD)
- Entries after this date will show
- end_date = String Date Format (YYYY-MM-DD)
- Entries before this date will show
- order_by = String [“asc”, “desc” – Default is descending]
- Optional parameter to order by ascending or descending timestamp
Payload Example:
{ "page": "1", "page_length": "5", "start_date": "2021-01-04", "end_date": "2024-09-05", "order_by": "desc" } |
Example discovery result for auditLogs/tcomm:
{ "recordsTotal": 38, "recordsFiltered": 7, "data": [ { "timestamp": "2024-02-02 17:18:42", "workflow_type": "Task", "workflow_name": "Swap Device Replacement with NY288-D-AHEND", "template_name": "Confirmation Email", "asset_name": "NY288-D-AHEND", "sent_asset_name": "Aliana Hendricks", "sent_asset_email": "ahendricks@readyworks.com", "status": "SUCCESS", "timestamp_formatted": "2024-02-02 17:18:42", "wave_id": "198", "task_id": "1333", "tcomm_template_id": "65", "id": "93" }, { "timestamp": "2024-02-02 17:18:26", "workflow_type": "Task", "workflow_name": "Swap Device Replacement with NY288-D-AHEND", "template_name": "Cancellation Email", "asset_name": "NY288-D-AHEND", "sent_asset_name": "Aliana Hendricks", "sent_asset_email": "ahendricks@readyworks.com", "status": "SUCCESS", "timestamp_formatted": "2024-02-02 17:18:26", "wave_id": "198", "task_id": "1328", "tcomm_template_id": "66", "id": "92" }, { "timestamp": "2023-05-01 11:43:18", "workflow_type": "Asset Rule", "workflow_name": "Offboard User Not in AD", "template_name": "Introduction [Refresh]", "asset_name": "Aahil Galindo", "sent_asset_name": "Aahil Galindo", "sent_asset_email": "agalindo@readyworks.com", "status": "SUCCESS", "timestamp_formatted": "2023-05-01 11:43:18", "wave_id": "2", "task_id": null, "tcomm_template_id": "32", "id": "51" }, { "timestamp": "2022-06-21 18:56:27", "workflow_type": "Wave", "workflow_name": "Packaging - Mekko Graphics", "template_name": "Introduction [Packaging]", "asset_name": "Norah Galloway", "sent_asset_name": "Norah Galloway", "sent_asset_email": "ngalloway@readyworks.com", "status": "SUCCESS", "timestamp_formatted": "2022-06-21 18:56:27", "wave_id": "185", "task_id": null, "tcomm_template_id": "43", "id": "38" }, { "timestamp": "2022-06-21 18:56:26", "workflow_type": "Wave", "workflow_name": "Packaging - EAS Outlook plugin", "template_name": "Introduction [Packaging]", "asset_name": "Rebekah Sharp", "sent_asset_name": "Rebekah Sharp", "sent_asset_email": "rsharp@readyworks.com", "status": "SUCCESS", "timestamp_formatted": "2022-06-21 18:56:26", "wave_id": "176", "task_id": null, "tcomm_template_id": "43", "id": "37" } ] } |
The discovery pull provides:
- recordsTotal = total number of records
- recordsFiltered = number of records filtered by date range
- data = record data for the currently selected page
URL: https://webroot/api/v1/auditLogs/tcomm
Parameters
Name | Description |
Authorization string (header)
* required
|
Default value: Bearer {token}
|
Body (body)
|
Example Value
|
application/json
|
|
{ "page": "1", "page_length": "5", "start_date": "2021-01-04", "end_date": "2024-09-05", "order_by": "desc" } |
|
Model |
|
Responses
Code | Description |
200
|
Example Value |
application/json | |
{ "recordsTotal": 38, "recordsFiltered": 7, "data": [ { "timestamp": "2024-02-02 17:18:42", "workflow_type": "Task", "workflow_name": "Swap Device Replacement with NY288-D-AHEND", "template_name": "Confirmation Email", "asset_name": "NY288-D-AHEND", "sent_asset_name": "Aliana Hendricks", "sent_asset_email": "alorentzen@readyworks.com", "status": "SUCCESS", "timestamp_formatted": "2024-02-02 17:18:42", "wave_id": "198", "task_id": "1333", "tcomm_template_id": "65", "id": "93" }, { "timestamp": "2024-02-02 17:18:26", "workflow_type": "Task", "workflow_name": "Swap Device Replacement with NY288-D-AHEND", "template_name": "Cancellation Email", "asset_name": "NY288-D-AHEND", "sent_asset_name": "Aliana Hendricks", "sent_asset_email": "alorentzen@readyworks.com", "status": "SUCCESS", "timestamp_formatted": "2024-02-02 17:18:26", "wave_id": "198", "task_id": "1328", "tcomm_template_id": "66", "id": "92" }, { "timestamp": "2023-05-01 11:43:18", "workflow_type": "Asset Rule", "workflow_name": "Offboard User Not in AD", "template_name": "Introduction [Refresh]", "asset_name": "Aahil Galindo", "sent_asset_name": "Aahil Galindo", "sent_asset_email": "agalindo@readyworks.com", "status": "SUCCESS", "timestamp_formatted": "2023-05-01 11:43:18", "wave_id": "2", "task_id": null, "tcomm_template_id": "32", "id": "51" }, { "timestamp": "2022-06-21 18:56:27", "workflow_type": "Wave", "workflow_name": "Packaging - Mekko Graphics", "template_name": "Introduction [Packaging]", "asset_name": "Norah Galloway", "sent_asset_name": "Norah Galloway", "sent_asset_email": "ngalloway@readyworks.com", "status": "SUCCESS", "timestamp_formatted": "2022-06-21 18:56:27", "wave_id": "185", "task_id": null, "tcomm_template_id": "43", "id": "38" }, { "timestamp": "2022-06-21 18:56:26", "workflow_type": "Wave", "workflow_name": "Packaging - EAS Outlook plugin", "template_name": "Introduction [Packaging]", "asset_name": "Rebekah Sharp", "sent_asset_name": "Rebekah Sharp", "sent_asset_email": "rsharp@readyworks.com", "status": "SUCCESS", "timestamp_formatted": "2022-06-21 18:56:26", "wave_id": "176", "task_id": null, "tcomm_template_id": "43", "id": "37" } ] } |
|
Model |
|
Headers
Name | Type |
Date | string |
Server | string |
X-Powered-By | string |
Content-Length | string |
Keep-Alive | string |
Connection | string |
auditLogs/etl5 Get ‘ETL5 Job Run’ Logs.
The endpoint has an optional JSON Body Payload containing five parameters:
- page = Integer [1 – Default Page 1]
- The page you want to show
- page_length = Integer [10 – Default 10 Records Per Page]
- The amount of entries to show for each page
- start_date = String Date Format (YYYY-MM-DD)
- Entries after this date will show
- end_date = String Date Format (YYYY-MM-DD)
- Entries before this date will show
- order_by = String [“asc”, “desc” – Default is descending]
- Optional parameter to order by ascending or descending timestamp
Payload Example:
{ "page": "1", "page_length": "5", "start_date": "2024-07-04", "end_date": "2024-08-05", "order_by": "desc" } |
Example discovery result for auditLogs/etl5:
{ "recordsTotal": 275, "recordsFiltered": 15, "data": [ { "run_id": "100", "connection_label": "rw", "connection_type": "inbound", "job_description": "ReadyWorks Connectors", "method_type": "GET", "success": "True", "start_time": "2024-08-13 12:36:25", "end_time": "2024-08-13 12:36:25", "time_in_sec": "0", "last_run_step": "INFO: Run Completed", "next_runtime": null }, { "run_id": "99", "connection_label": "rw", "connection_type": "inbound", "job_description": "GET RW Asset Types", "method_type": "GET", "success": "True", "start_time": "2024-08-13 12:35:26", "end_time": "2024-08-13 12:35:31", "time_in_sec": "5", "last_run_step": "INFO: Run Completed", "next_runtime": "2024-08-14 01:15:00" }, { "run_id": "98", "connection_label": "rw", "connection_type": "inbound", "job_description": "ReadyWorks Connectors", "method_type": "GET", "success": "False", "start_time": "2024-08-12 13:01:36", "end_time": "2024-08-12 13:01:38", "time_in_sec": "2", "last_run_step": "INFO: Run Completed", "next_runtime": null }, { "run_id": "97", "connection_label": "rw", "connection_type": "inbound", "job_description": "ReadyWorks Connectors", "method_type": "GET", "success": "False", "start_time": "2024-08-12 12:39:57", "end_time": "2024-08-12 12:39:57", "time_in_sec": "0", "last_run_step": "INFO: Run Completed", "next_runtime": null }, { "run_id": "96", "connection_label": "rw", "connection_type": "inbound", "job_description": "Calendars", "method_type": "GET", "success": "True", "start_time": "2024-07-30 16:31:18", "end_time": "2024-07-30 16:32:18", "time_in_sec": "60", "last_run_step": "INFO: Run Completed", "next_runtime": null } ] } |
The discovery pull provides:
- recordsTotal = total number of records
- recordsFiltered = number of records filtered by date range
- data = record data for the currently selected page
URL: https://webroot/api/v1/auditLogs/etl5
Parameters
Name | Description |
Authorization string (header)
* required
|
Default value: Bearer {token}
|
Body (body)
|
Example Value
|
application/json
|
|
{ "page": "1", "page_length": "5", "start_date": "2024-07-04", "end_date": "2024-09-05", "order_by": "desc" } |
|
Model |
|
Responses
Code | Description |
200
|
Example Value |
application/json | |
{ "recordsTotal": 275, "recordsFiltered": 15, "data": [ { "run_id": "100", "connection_label": "rw", "connection_type": "inbound", "job_description": "ReadyWorks Connectors", "method_type": "GET", "success": "True", "start_time": "2024-08-13 12:36:25", "end_time": "2024-08-13 12:36:25", "time_in_sec": "0", "last_run_step": "INFO: Run Completed", "next_runtime": null }, { "run_id": "99", "connection_label": "rw", "connection_type": "inbound", "job_description": "GET RW Asset Types", "method_type": "GET", "success": "True", "start_time": "2024-08-13 12:35:26", "end_time": "2024-08-13 12:35:31", "time_in_sec": "5", "last_run_step": "INFO: Run Completed", "next_runtime": "2024-08-14 01:15:00" }, { "run_id": "98", "connection_label": "rw", "connection_type": "inbound", "job_description": "ReadyWorks Connectors", "method_type": "GET", "success": "False", "start_time": "2024-08-12 13:01:36", "end_time": "2024-08-12 13:01:38", "time_in_sec": "2", "last_run_step": "INFO: Run Completed", "next_runtime": null }, { "run_id": "97", "connection_label": "rw", "connection_type": "inbound", "job_description": "ReadyWorks Connectors", "method_type": "GET", "success": "False", "start_time": "2024-08-12 12:39:57", "end_time": "2024-08-12 12:39:57", "time_in_sec": "0", "last_run_step": "INFO: Run Completed", "next_runtime": null }, { "run_id": "96", "connection_label": "rw", "connection_type": "inbound", "job_description": "Calendars", "method_type": "GET", "success": "True", "start_time": "2024-07-30 16:31:18", "end_time": "2024-07-30 16:32:18", "time_in_sec": "60", "last_run_step": "INFO: Run Completed", "next_runtime": null } ] } |
Headers
Name | Type |
Date | string |
Server | string |
X-Powered-By | string |
Content-Length | string |
Keep-Alive | string |
Connection | string |