UNPKG

files.com

Version:
83 lines (67 loc) 3.16 kB
# ActionNotificationExport ## Example ActionNotificationExport Object ``` { "id": 1, "export_version": "20201213.2", "start_at": "2000-01-01T01:00:00Z", "end_at": "2000-01-01T01:00:00Z", "status": "ready", "query_path": "MyFile.txt", "query_folder": "MyFolder", "query_message": "Connection Refused", "query_request_method": "GET", "query_request_url": "http://example.com/webhook", "query_status": "200", "query_success": true, "results_url": "https://files.com/action_notification_results.csv" } ``` * `id` (int64): History Export ID * `export_version` (string): Version of the underlying records for the export. * `start_at` (date-time): Start date/time of export range. * `end_at` (date-time): End date/time of export range. * `status` (string): Status of export. Valid values: `building`, `ready`, or `failed` * `query_path` (string): Return notifications that were triggered by actions on this specific path. * `query_folder` (string): Return notifications that were triggered by actions in this folder. * `query_message` (string): Error message associated with the request, if any. * `query_request_method` (string): The HTTP request method used by the webhook. * `query_request_url` (string): The target webhook URL. * `query_status` (string): The HTTP status returned from the server in response to the webhook request. * `query_success` (boolean): true if the webhook request succeeded (i.e. returned a 200 or 204 response status). false otherwise. * `results_url` (string): If `status` is `ready`, this will be a URL where all the results can be downloaded at once as a CSV. * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user. --- ## Show Action Notification Export ``` await ActionNotificationExport.find(id) ``` ### Parameters * `id` (int64): Required - Action Notification Export ID. --- ## Create Action Notification Export ``` await ActionNotificationExport.create({ 'user_id': 1, 'start_at': "2000-01-01T01:00:00Z", 'end_at': "2000-01-01T01:00:00Z", 'query_message': "Connection Refused", 'query_request_method': "GET", 'query_request_url': "http://example.com/webhook", 'query_status': "200", 'query_success': true, 'query_path': "MyFile.txt", 'query_folder': "MyFolder", }) ``` ### Parameters * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user. * `start_at` (string): Start date/time of export range. * `end_at` (string): End date/time of export range. * `query_message` (string): Error message associated with the request, if any. * `query_request_method` (string): The HTTP request method used by the webhook. * `query_request_url` (string): The target webhook URL. * `query_status` (string): The HTTP status returned from the server in response to the webhook request. * `query_success` (boolean): true if the webhook request succeeded (i.e. returned a 200 or 204 response status). false otherwise. * `query_path` (string): Return notifications that were triggered by actions on this specific path. * `query_folder` (string): Return notifications that were triggered by actions in this folder.