Report Exports

openapi: 3.0.0 info: title: Report Exports version: latest servers: - url: 'https://banno.com' tags: - name: Report retrieval - name: Report deactivation paths: '/a/report-export-retrieval/api/v0/institutions/{institutionId}/reports/{reportId}/data': get: description: | Retreive report export csv Requires the "Manage reports" permission security: - clientCredentials: [ https://jackhenry.com/report-export-generation/export.retrieve ] tags: - Report retrieval parameters: - $ref: "#/components/parameters/institutionId" - $ref: "#/components/parameters/reportId" responses: '200': description: OK content: text/csv: schema: type: string '404': description: Not found '/a/report-export-retrieval/api/v0/institutions/{institutionId}/reports/{reportId}/details': get: description: | Returns report details Requires the "Manage reports" permission security: - clientCredentials: [ https://jackhenry.com/report-export-generation/export.retrieve ] tags: - Report retrieval parameters: - $ref: "#/components/parameters/institutionId" - $ref: "#/components/parameters/reportId" responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/details" "404": description: Not found '/a/report-export-retrieval/api/v0/institutions/{institutionId}/reports/{reportId}/status': get: description: | Returns report export status Requires the "Manage reports" permission security: - clientCredentials: [ https://jackhenry.com/report-export-generation/export.retrieve ] tags: - Report retrieval parameters: - $ref: "#/components/parameters/institutionId" - $ref: "#/components/parameters/reportId" responses: "200": description: OK content: text/plain: schema: $ref: "#/components/schemas/status" "404": description: Not found '/a/report-export-retrieval/api/v0/institutions/{institutionId}/reports': get: description: | Returns array of report details for institution. Doesn't return deactivated reports or reports older than 90 days. Requires the "Manage reports" permission security: - clientCredentials: [ https://jackhenry.com/report-export-generation/export.retrieve ] tags: - Report retrieval parameters: - $ref: "#/components/parameters/institutionId" responses: "200": description: OK content: application/json: schema: type: array items: $ref: "#/components/schemas/details" "404": description: Not found "/a/report-export-generation/api/v0/institutions/{institutionId}/reports/{reportId}": delete: description: | deactivates report by reportId Requires the "Manage reports" permission security: - clientCredentials: [ https://jackhenry.com/report-export-generation/export.retrieve ] tags: - Report deactivation parameters: - $ref: "#/components/parameters/institutionId" - $ref: "#/components/parameters/reportId" responses: "204": description: OK 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: in: path name: institutionId description: ID of an institution required: true schema: type: string format: uuid reportId: in: path name: reportId description: ID of a report required: true schema: type: string format: uuid schemas: details: description: Report meta data and status type: object properties: id: type: string description: report id format: uuid type: type: string description: report type enum: - AppUsage_Signups - AppUsage_ActiveUsers - AppUsage_EnrolledUsers - AppUsage_LoginAudit - AppUsage_UserIdentifierMapping - BillPay_ActiveUsers - BillPay_InactiveUsers - RemoteDepositCapture_Pending - RemoteDepositCapture_Approved - RemoteDepositCapture_Rejected - RemoteDepositCapture_NotEnrolled - Conversations_AllConversations - Conversations_AllAgents - Transfers_InternalActiveUsers - Transfers_InternalInactiveUsers - Transfers_InternalMemberToMember - Transfers_ExternalActiveUsers - Transfers_ExternalInactiveUsers - Transfers_ExternalMicroDepositStatus - Platform_Permissions - Fraud_PotentiallyCompromisedUsers - Fraud_NewUsersWithUnverified2FA since: type: string description: utc datetime, lowerbound of date range of report format: date-time until: type: string description: utc datetime, upperbound of date range of report format: date-time institutionId: type: string format: uuid status: $ref: "#/components/schemas/status" requestedBy: type: string description: institution user id that requested report format: uuid requestedOn: type: string description: utc datetime, datetime report was requested format: date-time status: type: string description: status type enum: - Cancelled - Processing - Failed - Pending - Complete