History Events Retrieval

openapi: 3.0.3 info: title: History Events Retrieval version: latest servers: - url: 'https://banno.com' tags: - name: listing description: Retrieve list of History events, given search query parameters paths: '/a/history/api/v0/institutions/{institutionId}/user-events': get: description: >- List events for Admin/Enterprise API users (employees of Financial Institutions). Results are returned in descending chronological order: most recent to oldest. Requires the "Users View activity" permission tags: - listing security: - clientCredentials: [ https://jackhenry.com/history/user-events.read ] parameters: - $ref: '#/components/parameters/InstitutionId' - $ref: '#/components/parameters/From' - $ref: '#/components/parameters/To' - $ref: '#/components/parameters/Application' - $ref: '#/components/parameters/Change' - $ref: '#/components/parameters/UserId' - $ref: '#/components/parameters/Count' - $ref: '#/components/parameters/Offset' responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/Event' '400': description: Bad Request '404': description: Not found '500': description: Internal Server Error '/a/history/api/v0/institutions/{institutionId}/person-events': get: description: >- List events for Consumer API persons (customers of Financial Institutions). Results are returned in descending chronological order: most recent to oldest. Requires the "Activity View employee events" permission tags: - listing security: - clientCredentials: [ https://jackhenry.com/history/person-events.read ] parameters: - $ref: '#/components/parameters/InstitutionId' - $ref: '#/components/parameters/From' - $ref: '#/components/parameters/To' - $ref: '#/components/parameters/Application' - $ref: '#/components/parameters/Change' - $ref: '#/components/parameters/PersonId' - $ref: '#/components/parameters/Count' - $ref: '#/components/parameters/Offset' responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/Event' '400': description: Bad Request '404': description: Not found '500': description: Internal Server Error components: securitySchemes: clientCredentials: type: oauth2 description: OAuth2 using the client credentials flow flows: clientCredentials: tokenUrl: https://banno.com/a/oidc-provider/api/v0/token scopes: {} parameters: InstitutionId: name: institutionId in: path required: true schema: type: string format: uuid From: name: from description: >- The lower bound (oldest) of the time range. The maximum difference between the `from` and `to` parameters is 7 days (168 hours). Smaller timeframes are more performant. Queries with a time difference of >7 days between `from` and `to` may be rejected or time out. Example: if `to` is `2020-06-20T13:00:00.000Z` the `from` parameter must be >= `2020-06-13T13:00:00.000Z`. in: query required: true schema: type: string format: date-time example: "2022-01-24T22:10:00.000Z" To: name: to description: >- The upper bound (most recent) of the time range. The maximum difference between the `from` and `to` parameters is 7 days (168 hours). Smaller timeframes are more performant. Queries with a time difference of >7 days between `from` and `to` may be rejected or time out. Example: if `to` is `2020-06-20T13:00:00.000Z` the `from` parameter must be >= `2020-06-13T13:00:00.000Z`. in: query required: true schema: type: string format: date-time example: "2022-02-07T22:10:00.000Z" Application: name: application description: >- A specific application name to filter by. The default behavior is to return events for all applications. in: query schema: type: string Change: name: change description: >- A particular event name to filter by. The default behavior is to return events for all event types. in: query schema: type: string Count: name: count description: >- Minimum 1. Maximum 1,000. When the response includes >=`count` events you can make a new request with the `offset` parameter increased by the previous query's `count`. in: query required: true schema: type: integer minimum: 1 maximum: 1000 Offset: name: offset description: The number of events to skip. This must be used in conjunction with the `count` parameter. in: query required: true schema: type: integer minimum: 0 UserId: name: userId description: Enterprise/Admin User's ID. These are employees of Financial Institutions. in: query schema: type: string format: uuid PersonId: name: personId description: Consumer Person's ID. These are customers of Financial Institutions. in: query schema: type: string format: uuid schemas: Event: type: object properties: eventId: type: string date: type: string format: date-time institutionId: type: string change: type: object properties: {} example: eventId: 456911aa-5030-4cb6-afda-76857f69a46a date: '2009-03-04T13:54:20.841Z' institutionId: 8e090da9-3b4a-4f62-9949-1e5a38b42424 change: user: userId: 87ab0dd8-d398-48cc-9df4-309f95c27d47 userName: Frank Bob userIp: 255.255.255.255 name: UserPasswordChanged application: users