Boomi Data Integration API Reference (1.0.0) - AuditEvents

Toggle Pane

• Audit Events
  • getList Audit Events
  • getGet Audit Event

API docs by Redocly

Download OpenAPI Specification: Download

Find out more about Data Integration

Audit Events

Listing account's audit events

List Audit Events

Authorization scope: audit:list

List audit events

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)

query Parameters

	Start Time (string) or Start Time (null) (Start Time) Examples: start_time=2020-01-01T12:00:00 The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm
	End Time (string) or End Time (null) (End Time) Examples: end_time=2020-01-01T12:00:00 The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm If end_time is supplied without start_time the start_time will be the previous day of the end_time
	Array of User Id (strings) or User Id (null) (User Id) Examples: user_id=5eda28ee6b028e1ce7a2b5ed A list of users id's who initiated the event
	Array of Event Type (strings) or Event Type (null) (Event Type) Examples: event_type=connections event_type=rivers event_type=river_groups A list of entity types
	Array of Entity Type (strings) or Entity Type (null) (Entity Type) Examples: entity_type=delete entity_type=create entity_type=update A list of event types
	Entity Logical Key (string) or Entity Logical Key (null) (Entity Logical Key) Examples: entity_logical_key=5eda28ee6b028e1ce7a2b5ec A unique logical identifier of an entity, usually the cross_id

Responses

Response Schema: application/json

required	Array of objects (Items)
	Next Page (string) or Next Page (null) (Next Page) The next page URL
	Previous Page (string) or Previous Page (null) (Previous Page) The previous page URL

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/audit_events

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/audit_events

Response samples

• 200
• 422

Content type

application/json

{

• "next_page": "string",
• "previous_page": "string",
• "items": [

  • {

    • "event_id": "eac285a5a9ae4ada9ccd49889a651e16",
    • "event_initiator": "UI",
    • "event_datetime": "2022-08-02T13:38:44.054000",
    • "event_type": "create",
    • "event_result_status": 200,
    • "event_name": "update:rivers:without_version",
    • "entity_type": "rivers",
    • "entity_logical_key": "5eda28ee6b028e1ce7a2b5ec",
    • "account_id": "5ebec4ca6b028e2da4191dde",
    • "environment_id": "5ebec4ca6b028e2da4191de1",
    • "user_id": "60d08931f5682c0d9fa24890",
    • "user_name": "Rivi Ee",
    • "entity_name": "My First River",
    • "entity_subtype": "src_to_trgt",
    • "additional_info": "{\"version_id\": \"637582d3c32287000fc1d69f\"}"

    }

  ]

}

Get Audit Event

Authorization scope: audit:list

Get a specific audit event by event_id.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
event_id required	string (Event Id) Examples: eac285a5a9ae4ada9ccd49889a651e16 The id of the audit event

Responses

Response Schema: application/json

event_id required	string (Event Id) The id of the audit event
event_initiator required	string (Event Initiator) Where the event was initiated
event_datetime required	string (Event Datetime) The event date time in UTC timezone
event_type required	string (AuditEventTypeEnum) Enum: "create" "recover" "delete" "update" "initiate_activate_river" "initiate_disable_river" "edit_cdc_configuration" "delete_cdc_configuration" The type of the event
event_result_status required	integer (Event Result Status) The status of the API request of the event
event_name required	string (Event Name) The name of the event in the following format-event_type:entity_type:additional_info
entity_type required	string (AuditEntityTypeEnum) Enum: "accounts" "connections" "rivers" "river_groups" "users" "teams" The type of entity that was recorded
account_id required	string (Account Id) The account id the event originated for
environment_id required	string (Environment Id) The environment id the event originated for
user_id required	string (User Id) The user id the event originated for
entity_logical_key	string (Entity Logical Key) Default: "A unique logical identifier of an entity, usually the cross_id"
	User Name (string) or User Name (null) (User Name) The name of the user that originated the event
	Entity Name (string) or Entity Name (null) (Entity Name) The name of the event entity, this could be the name of the river, connection etc.
	Entity Subtype (string) or Entity Subtype (null) (Entity Subtype) The even subtype, this could be a river classification like logic or s2t rivers
	Additional Info (string) or Additional Info (null) (Additional Info) Default: "Additional information saved for the event"

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/audit_events/{event_id}

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/audit_events/{event_id}

Response samples

• 200
• 422

Content type

application/json

{

• "event_id": "eac285a5a9ae4ada9ccd49889a651e16",
• "event_initiator": "UI",
• "event_datetime": "2022-08-02T13:38:44.054000",
• "event_type": "create",
• "event_result_status": 200,
• "event_name": "update:rivers:without_version",
• "entity_type": "rivers",
• "entity_logical_key": "5eda28ee6b028e1ce7a2b5ec",
• "account_id": "5ebec4ca6b028e2da4191dde",
• "environment_id": "5ebec4ca6b028e2da4191de1",
• "user_id": "60d08931f5682c0d9fa24890",
• "user_name": "Rivi Ee",
• "entity_name": "My First River",
• "entity_subtype": "src_to_trgt",
• "additional_info": "{\"version_id\": \"637582d3c32287000fc1d69f\"}"

}