openapi: 3.0.0
info:
  title: Exports
  version: 2.0.0
  description: API Documentation
  contact:
    name: OpsRamp Support
    email: support@opsramp.com
    url: 'https://www.opsramp.com/about-opsramp/contact-us/'
tags:
  - name: exports
    description: Exports API Documentation.
    externalDocs:
      url: 'https://develop.opsramp.com/exports'
servers:
  - url: 'https://api.opsramp.com'
    description: Partner - All Others
  - url: 'https://{subdomain}.api.opsramp.com'
    description: Partner or Client custom branded sub-domain
    variables:
      subdomain:
        default: demo
        description: Custom sub-domain assigned to the client
paths:
  '/api/v2/tenants/{partnerId}/exports/batch-exports':
    x-new-path: true
    summary: Batch Exports
    deprecated: true
    description: |-
      <b>Deprecated:</b> This API will be deprecated and no longer supported starting <b>June 2025</b>.

      Creates an on-demand or recurring batch export configurations.

    post:
      tags:
        - exports
      responses:
        '200':
          $ref: '#/components/responses/batchexportId'
      operationId: batch-exports-details
      description: |-
        <b>Note</b>: To use this API, you must enable the <b>Batch Exports Add-on</b>. You also need to have the <b>REPORTS_MANAGE</b> and <b>INTEGRATION_MANAGE</b> permissions assigned.
        
        Create a batch export configuration
        ## Notes
        - Metric export configurations supports only recurring with default hourly schedule.User defined schedule is neither supported nor required.
        - Integration export configurations doesn't supports selective integration category.All Integration categories are selected by default.
        - Day of month can have any values between 1 to 27 alongwith 'last'
          - recurring at 'last' day of the month.
          - recurring at '2' nd day of month.
      requestBody:
        $ref: '#/components/requestBodies/batchExportReq'
    parameters:
      - schema:
          type: string
        name: partnerId
        in: path
        required: true
    get:
      summary: List batch exports
      operationId: get-api-v2-tenants-partnerId-exports-batch-exports
      responses:
        '200':
          $ref: '#/components/responses/batchExpoList'
      description: |
        <b>Note</b>: To use this API, you must enable the <b>Batch Exports Add-on</b> and have the <b>REPORTS_MANAGE</b> and <b>INTEGRATION_VIEW</b> permissions assigned.

        List all the batch export configurations
      parameters:
        - schema:
            type: string
          in: query
          name: name
          description: Batch export name
        - schema:
            type: string
          in: query
          name: pageSize
          description: Page size
        - schema:
            type: string
          in: query
          name: pageNo
          description: PageNo
  '/api/v2/tenants/{partnerId}/exports/batch-exports/{id}':
    x-new-path: true
    summary: Manage Batch Export
    deprecated: true
    description: |-
      <b>Deprecated:</b> This API will be deprecated and no longer supported starting <b>June 2025</b>.
      
      Updates, delete or get batch export details.
    put:
      tags:
        - exports
      responses:
        '200':
          $ref: '#/components/responses/batchexportId'
      operationId: batch-exports
      description: |
        <b>Note</b>: To use this API, you must enable the <b>Batch Exports Add-on</b>. You also need to have the <b>REPORTS_MANAGE</b> and <b>INTEGRATION_EDIT</b> permissions assigned.
        
        
        Update batch export configuration
      requestBody:
        $ref: '#/components/requestBodies/batchExportReq'
    parameters:
      - schema:
          type: string
        name: partnerId
        in: path
        required: true
      - schema:
          type: string
        name: id
        in: path
        required: true
    delete:
      summary: ''
      operationId: delete-api-v2-tenants-partnerId-exports-batch-exports-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: string
                x-examples:
                  Example 1:
                    result: successfully deleted schexp-382074f3-089a-435c-b686-13f9af7c6c63
              examples:
                example-sucessful-delete:
                  value:
                    result: successfully deleted schexp-382074f3-089a-435c-b686-13f9af7c6c63
      description: |
        <b>Note</b>: To use this API, you need to have the <b>INTEGRATION_MANAGE</b> permission assigned.
        
        Delete existing barch export configuration
    get:
      summary: Get Details
      operationId: get-api-v2-tenants-partnerId-exports-batch-exports-id
      responses:
        '200':
          $ref: '#/components/responses/batchExportRes'
      description: |
        <b>Note</b>: To use this API, you must enable the <b>Batch Exports Add-on</b> and have the <b>REPORTS_MANAGE</b> and <b>INTEGRATION_VIEW</b> permissions assigned.

        Get details of a batch export configuration
  '/api/v2/tenants/{partnerId}/exports/streaming':
    summary: Alert Streaming  Configuration
    deprecated: true
    description: |-
      <b>Deprecated:</b> This API will be deprecated and no longer supported starting <b>June 2025</b>.

      Manages on-demand Streaming  Configuration.

      ### Notes
      User with roles with below permissions are permitted to use the APIs
       - The User who creates Streaming Configuration.
       - Partner Admin user who has all managed permissions.
       - Partner user who has administration permission
       - Service Provider user.
    x-new-path: true
    parameters:
      - $ref: '#/components/parameters/partnerId'
    get:
      summary: Get Streaming Configuration Details
      tags:
        - exports
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/responseStreamModel'
                  totalResults:
                    type: integer
                  pageNo:
                    type: integer
                  pageSize:
                    type: integer
                  totalPages:
                    type: integer
                  nextPage:
                    type: boolean
                  descendingOrder:
                    type: boolean
              examples:
                example-streaming:
                  value:
                    results:
                      - id: streamexp-6f3a09ce-12fc-404a-922a-bdc2890fa71b
                        name: alert streaming
                        allClients: false
                        categoryType: Alerts
                        rawEvents: false
                        exportIntegration:
                          id: INTG-8528ea12-14af-4065-9cae-a6ac19e4beaa
                          name: streamExport
                        clients:
                          - id: client_13
                            name: Job Testing
                          - id: client_11
                            name: Ops Lab
                    totalResults: 1
                    pageNo: 1
                    pageSize: 100
                    totalPages: 1
                    nextPage: false
                    descendingOrder: false
                example-streaming-allclients:
                  value:
                    results:
                      - id: streamexp-9173349a-e2f5-4f1f-a618-ca74f4af8719
                        name: alert webhook stream
                        allClients: true
                        categoryType: Alerts
                        rawEvents: false
                        exportIntegration:
                          id: INTG-e781d9f9-1c98-4011-8cd5-aad082c77de4
                          name: Streaming-Alerting-Test Integration
                    totalResults: 1
                    pageNo: 1
                    pageSize: 100
                    totalPages: 1
                    nextPage: false
                    descendingOrder: false
            application/xml:
              schema:
                type: object
                properties: {}
      operationId: get-api-v2-tenants-tenantId-exports-alertStream
      parameters:
        - schema:
            type: string
          in: query
          name: name
          description: Streaming name
      description: |
        <b>Note</b>: To use this API, you must enable the <b>Stream Exports Add-on</b> and have the <b>REPORTS_MANAGE</b> and <b>INTEGRATION_VIEW</b> permissions assigned.
        
        Get the streaming configurations.
    post:
      summary: Create An Streaming Configuration
      operationId: post-api-v2-tenants-tenantId-exports-streaming
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
              examples:
                alert-stream:
                  value:
                    id: streamexp-2e84f4fb-d1bc-435f-8c1e-62690989e17c
                    name: alert-webhook-stream
      requestBody:
        $ref: '#/components/requestBodies/alertStream'
      tags:
        - exports
      description: |
        <b>Note</b>: To use this API, you must enable the <b>Stream Exports Add-on</b>. You also need to have the <b>REPORTS_MANAGE</b> and <b>INTEGRATION_MANAGE</b> permissions assigned.
        
        Create streaming configurations.
  '/api/v2/tenants/{partnerId}/exports/streaming/{id}':
    summary: Manage Alert Streaming Configuration
    deprecated: true
    description: |-
      <b>Deprecated:</b> This API will be deprecated and no longer supported starting <b>June 2025</b>.
      
      Manages an on-demand Streaming  Configuration.
    x-new-path: true
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
        description: Streaming uuid
      - $ref: '#/components/parameters/partnerId'
    put:
      summary: ''
      operationId: post-api-v2-tenants-tenantId-exports-streaming-configId
      responses:
        '200':
          $ref: '#/components/responses/responseAlertStream'
      tags:
        - exports
      description: |
        <b>Note</b>: To use this API, you must enable the <b>Stream Exports Add-on</b>. You also need to have the <b>REPORTS_MANAGE</b> and <b>INTEGRATION_EDIT</b> permissions assigned.
        
        Update Streaming Configuration attributes.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/streamModel'
            examples:
              example-update-streaming:
                value:
                  clients:
                    - client_12
                    - client_28
                    - 37be2441-1636-4756-93da-5cb1d95da2b6fh8ei9
                  exportIntegration: INTG-37be2441-1636-4756-93da-5cb1d95da2b6
                  rawEvents: false
    get:
      summary: ''
      operationId: get-api-v2-tenants-tenantId-exports-streaming-id
      responses:
        '200':
          $ref: '#/components/responses/responseStream'
      description: |
        <b>Note</b>: To use this API, you must enable the <b>Stream Exports Add-on</b> and have the <b>REPORTS_MANAGE</b> and <b>INTEGRATION_VIEW</b> permissions assigned.
        
        Get Steaming Details.
      tags:
        - exports
    delete:
      summary: ''
      operationId: delete-api-v2-tenants-tenantId-exports-streaming-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: string
              examples:
                example-delete-stream:
                  value:
                    result: successfully deleted streamexp-36443697-3965-4a0c-8b82-1941fd08300a
      description: |
        <b>Note</b>: To use this API, you need to have the <b>REPORTS_MANAGE</b> and <b>INTEGRATION_MANAGE</b> permissions assigned.
        
        Delete a Streaming Configuration.
      tags:
        - exports
components:
  securitySchemes:
    accessToken:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: 'https://subdomain.api.opsramp.com'
          scopes: {}
  parameters:
    tenantId:
      in: path
      name: tenantId
      schema:
        type: string
      required: true
      description: 'Describes clientId or partnerId '
    partnerId:
      name: partnerId
      in: path
      required: true
      schema:
        type: string
      description: Describes the unique  identifier of the provider (mspId)
  schemas:
    export:
      title: export
      type: object
      properties:
        name:
          type: string
          description: |
            Name of the batch export template.
        scheduleType:
          type: string
          description: |
            Defines the schedule type. Example: ON-DEMAND.
          enum:
            - ON-DEMAND
            - RECURRING
        recurringType:
          type: string
          description: 'Defines the recurring type of batch export. Supported values: Daily, Weekly, Monthly.'
          enum:
            - Daily
            - Weekly
            - Monthly
        integrationId:
          type: string
          description: |
            Integration ID.
        type:
          type: string
          description: |
            Defines the batch type to export. Supported values: Inventory, Alerts, Tickets, Metrics.
          enum:
            - Inventory
            - Alerts
            - Tickets
            - Metrics
        startHours:
          type: string
          description: |
            Defines the starting time of daily recurring in hours. Supported values: 00 to 23.
        startMins:
          type: string
          description: |
            Defines the starting time of daily recurrence in minutes. Supported values: 00 to 59.
        startDate:
          type: string
          description: |
            Defines the starting date of monthly recurrence of batch export. Supported values: 01st to 27th or last day of the month.
        startDay:
          type: string
          description: |
            Defines the starting day of the weekly recurrence of batch export. Supported values: SUN, MON, TUE, WED, THU, FRI, SAT.
          enum:
            - SUN
            - MON
            - TUE
            - WED
            - THU
            - FRI
            - SAT
      required:
        - name
        - scheduleType
        - recurringType
        - integrationId
        - type
    streamModel:
      title: streamModel
      type: object
      description: ''
      properties:
        id:
          type: string
        name:
          type: string
        clients:
          type: array
          items:
            type: string
        categoryType:
          type: string
          example: Alerts
          enum:
            - Alerts
        exportIntegration:
          type: string
          x-more-information-url: /docs/v2/integrations/tenants-tenantid-integrations-install-uniquename
          x-more-information-title: See "Install Integrations" e.g. Install WEBHOOKRECIEVER
        rawEvents:
          type: boolean
          default: false
        allClients:
          type: boolean
          default: true
          description: Include all the clients. 'true' to select all clients.
    responseStreamModel:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        clients:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
        categoryType:
          type: string
        exportIntegration:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
        rawEvents:
          type: boolean
        allClients:
          type: boolean
    batch-export:
      type: object
      properties:
        name:
          type: string
          description: Batch Export Name
        allClients:
          type: boolean
          description: Enable all clients
          default: false
        client:
          type: string
          description: Specific client list
        scheduleType:
          type: string
          description: Scheduler type
          enum:
            - RECURRING
            - ON-DEMAND
          default: ON-DEMAND
          example: ON-DEMAND
        categoryType:
          type: string
          enum:
            - Alerts
            - Audit
            - Usage
            - Integrations
            - Metrics
            - Inventory
          description: Batch export type
        recurringType:
          type: string
          enum:
            - Weekly
            - Monthly
            - Daily
          default: Monthly
          example: Monthly
          description: Recurring type to be used only when recurring configuration is done.
        exportIntegration:
          type: object
          description: Integration associated
          properties:
            id:
              type: string
              description: Integration uuid
        isFailureExportNotification:
          type: boolean
          description: Enable failed export notification
        dayOfMonth:
          type: string
          description: Scheduled day of month. To be used only for Monthly Recurring configuration.Use any values between 1 to 27 and 'last'.
          enum:
            - last
            - '1'
            - '2'
          default: last
          example: '2'
        dayOfWeek:
          type: string
          description: Scheduled week. To be used only for Weekly Recurring configurations.
          enum:
            - SUN
            - MON
            - TUE
            - WED
            - THU
            - FRI
            - SAT
        startHours:
          type: string
          description: Scheduled hour. To be used during Recurring configurations.
        startMinutes:
          type: string
          description: Scheduled minute. To be used during Recurring configurations.
      required:
        - name
        - allClients
        - clients
        - scheduleType
        - categoryType
        - exportIntegration
    batch-export-details:
      type: object
      properties:
        id:
          type: string
          description: Batch export uuid
        name:
          type: string
          description: Batch export configuration name
        allClients:
          type: boolean
          default: false
        clients:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
        categoryType:
          type: string
        exportIntegration:
          type: object
          description: Integration details
          properties:
            id:
              type: string
            name:
              type: string
        recurringType:
          type: string
        scheduleType:
          type: string
        startHours:
          type: string
        startMinutes:
          type: string
        createdTime:
          type: string
        updatedTime:
          type: string
        dayOfMonth:
          type: string
        createdBy:
          type: object
          description: created by
          properties:
            id:
              type: string
            loginName:
              type: string
            firstName:
              type: string
            lastName:
              type: string
        updatedBy:
          type: object
          description: last updated by
          properties:
            id:
              type: string
            loginName:
              type: string
            firstName:
              type: string
            lastName:
              type: string
        isFailureExportNotification:
          type: boolean
  requestBodies:
    alertStream:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/streamModel'
          examples:
            example-clients:
              value:
                name: alert webhook stream
                clients:
                  - client_12
                  - client_28
                  - 37be2441-1636-4756-93da-5cb1d95da2b6fh8ei9
                categoryType: Alerts
                exportIntegration: INTG-37be2441-1636-4756-93da-5cb1d95da2b6
                rawEvents: false
            example-all-clients:
              value:
                name: alert webhook stream
                allClients: true
                categoryType: Alerts
                exportIntegration: INTG-37be2441-1636-4756-93da-5cb1d95da2b6
                rawEvents: false
    batchExportReq:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/batch-export'
          examples:
            example-batch-export-configuration-on-demand:
              value:
                name: Ondemand Inventory Export
                client: 20277e46-052e-4146-b809-e1da9b54a516
                scheduleType: ON-DEMAND
                categoryType: Inventory
                exportIntegration:
                  id: INTG-20277e46-052e-4146-b809-e1da9b54a516
                isFailureExportNotification: true
            example-batch-export-recurring-daily:
              value:
                name: Recurring Inventory Export
                allClients: false
                client: 20277e46-052e-4146-b809-e1da9b54a516
                categoryType: Inventory
                scheduleType: RECURRING
                recurringType: Daily
                startHours: 10
                startMinutes: 30
                exportIntegration:
                  id: INTG-20277e46-052e-4146-b809-e1da9b54a516
                isFailureExportNotification: true
            example-batch-export-recurring-weekly:
              value:
                name: Recurring Inventory Export
                allClients: false
                client: 20277e46-052e-4146-b809-e1da9b54a516
                categoryType: Inventory
                scheduleType: RECURRING
                recurringType: Weekly
                dayOfWeek: Fri
                startHours: 10
                startMinutes: 30
                exportIntegration:
                  id: INTG-20277e46-052e-4146-b809-e1da9b54a516
                isFailureExportNotification: true
            example-batch-export-monthly:
              value:
                name: Recurring Inventory Export
                client: 20277e46-052e-4146-b809-e1da9b54a516
                categoryType: Inventory
                scheduleType: RECURRING
                recurringType: Monthly
                dayOfMonth: last
                startHours: 12
                startMinutes: 15
                exportIntegration:
                  id: INTG-20277e46-052e-4146-b809-e1da9b54a516
                isFailureExportNotification: true
            example-batch-export-metrics:
              value:
                name: Recurring Metric Export
                allClients: false
                client: 322ff0e9-32f2-477a-b3ba-899d5d8cb2ef
                scheduleType: RECURRING
                categoryType: Metrics
                exportIntegration:
                  id: INTG-06aa9401-e2d8-459c-b476-40e6cd09eab0
            example-batch-exports-integrations:
              value:
                name: Ondemand Inventory Export
                allClients: false
                client: 322ff0e9-32f2-477a-b3ba-899d5d8cb2ef
                scheduleType: ON-DEMAND
                categoryType: Integrations
                exportIntegration:
                  id: INTG-20277e46-052e-4146-b809-e1da9b54a516
                isFailureExportNotification: true
      description: ''
  responses:
    responseStream:
      description: Example response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/responseStreamModel'
          examples:
            example-streaming:
              value:
                id: streamexp-36443697-3965-4a0c-8b82-1941fd08300a
                name: alert webhook stream
                allClients: true
                categoryType: Alerts
                rawEvents: false
                exportIntegration:
                  id: INTG-37be2441-1636-4756-93da-5cb1d95da2b6
                  name: EventBridge1
    responseAlertStream:
      description: Example response
      content:
        application/json:
          schema:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
          examples:
            example-webhook-streamning:
              value:
                id: streamexp-2e84f4fb-d1bc-435f-8c1e-62690989e17c
                name: alert-webhook-stream
    batchExportRes:
      description: Example response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/batch-export-details'
          examples:
            example-detaild-batch-export-configuration:
              value:
                id: schexp-ef3a1f8e-611b-4ee5-a484-714eaa556b83
                name: Alert
                allClients: false
                clients:
                  - id: client_14
                    name: OpsRamp Lab
                categoryType: Alerts
                exportIntegration:
                  id: INTG-0bf95fbc-21fc-42a9-a161-a91043d68234
                  name: s3
                recurringType: Monthly
                scheduleType: Recurring
                startHours: '00'
                startMinutes: '00'
                createdTime: '2022-09-08T03:36:46+0000'
                updatedTime: '2022-10-18T06:49:59+0000'
                dayOfMonth: '21'
                createdBy:
                  id: USR0000000001
                  loginName: OpsRamp
                  firstName: OpsRamp
                  lastName: User
                updatedBy:
                  id: USR0000000001
                  loginName: OpsRamp
                  firstName: OpsRamp
                  lastName: User
                isFailureExportNotification: false
    batchExpoList:
      description: Example response
      content:
        application/json:
          schema:
            type: object
            x-examples:
              Example 1:
                results:
                  - id: schexp-591b4ac2-53d4-4eac-9b3d-e3319780a493
                    name: 'Alerts Export '
                    allClients: false
                    clients:
                      - id: client_13
                        name: Job Testing
                    categoryType: Alerts
                    exportIntegration:
                      id: INTG-0bf95fbc-21fc-42a9-a161-a91043d68234
                      name: AWS S3 Export Integration
                    recurringType: Monthly
                    scheduleType: Recurring
                    startHours: '7'
                    startMinutes: '7'
                    createdTime: '2023-01-25T00:47:28+0000'
                    updatedTime: '2023-01-25T00:50:06+0000'
                    dayOfMonth: '5'
                    createdBy:
                      id: USR0000000001
                      loginName: OpsRamp
                      firstName: OpsRamp
                      lastName: User
                    updatedBy:
                      id: USR0000000001
                      loginName: OpsRamp
                      firstName: OpsRamp
                      lastName: User
                    isFailureExportNotification: false
                  - id: schexp-29b99149-859c-4c35-b999-58743ed0d4ae
                    name: Inventory Export
                    allClients: false
                    clients:
                      - id: client_14
                        name: OpsRamp Lab
                    categoryType: Inventory
                    exportIntegration:
                      id: INTG-0bf95fbc-21fc-42a9-a161-a91043d68234
                      name: AWS S3 Export Integration
                    recurringType: Monthly
                    scheduleType: Recurring
                    startHours: '00'
                    startMinutes: '00'
                    createdTime: '2022-09-08T03:36:46+0000'
                    updatedTime: '2022-10-18T06:49:59+0000'
                    dayOfMonth: '21'
                    createdBy:
                      id: USR0000000001
                      loginName: OpsRamp
                      firstName: OpsRamp
                      lastName: User
                    updatedBy:
                      id: USR0000000001
                      loginName: OpsRamp
                      firstName: OpsRamp
                      lastName: User
                    isFailureExportNotification: false
                totalResults: 2
                orderBy: id
                pageNo: 1
                pageSize: 100
                totalPages: 1
                nextPage: false
                previousPageNo: 0
                descendingOrder: true
            properties:
              results:
                type: array
                items:
                  $ref: '#/components/schemas/batch-export-details'
              totalResults:
                type: integer
              orderBy:
                type: string
              pageNo:
                type: integer
              pageSize:
                type: integer
              totalPages:
                type: integer
              nextPage:
                type: boolean
              previousPageNo:
                type: integer
              descendingOrder:
                type: boolean
          examples:
            example-batch-exports-list:
              value:
                results:
                  - id: schexp-591b4ac2-53d4-4eac-9b3d-e3319780a493
                    name: 'Alerts Export '
                    allClients: false
                    clients:
                      - id: client_13
                        name: Job Testing
                    categoryType: Alerts
                    exportIntegration:
                      id: INTG-0bf95fbc-21fc-42a9-a161-a91043d68234
                      name: AWS S3 Export Integration
                    recurringType: Monthly
                    scheduleType: Recurring
                    startHours: '7'
                    startMinutes: '7'
                    createdTime: '2023-01-25T00:47:28+0000'
                    updatedTime: '2023-01-25T00:50:06+0000'
                    dayOfMonth: '5'
                    createdBy:
                      id: USR0000000001
                      loginName: OpsRamp
                      firstName: OpsRamp
                      lastName: User
                    updatedBy:
                      id: USR0000000002
                      loginName: OpsRamp
                      firstName: OpsRamp
                      lastName: User
                    isFailureExportNotification: false
                  - id: schexp-29b99149-859c-4c35-b999-58743ed0d4ae
                    name: Inventory Export
                    allClients: false
                    clients:
                      - id: client_14
                        name: OpsRamp Lab
                    categoryType: Inventory
                    exportIntegration:
                      id: INTG-0bf95fbc-21fc-42a9-a161-a91043d68234
                      name: AWS S3 Export Integration
                    recurringType: Monthly
                    scheduleType: Recurring
                    startHours: '00'
                    startMinutes: '00'
                    createdTime: '2022-09-08T03:36:46+0000'
                    updatedTime: '2022-10-18T06:49:59+0000'
                    dayOfMonth: '21'
                    createdBy:
                      id: USR0000000001
                      loginName: OpsRamp
                      firstName: OpsRamp
                      lastName: User
                    updatedBy:
                      id: USR0000000001
                      loginName: OpsRamp
                      firstName: OpsRamp
                      lastName: User
                    isFailureExportNotification: false
                totalResults: 2
                orderBy: id
                pageNo: 1
                pageSize: 100
                totalPages: 1
                nextPage: false
                previousPageNo: 0
                descendingOrder: true
    batchexportId:
      description: Example response
      content:
        application/json:
          schema:
            type: object
            properties:
              id:
                type: string
          examples:
            example-batch-export-id:
              value:
                id: schexp-ef3a1f8e-611b-4ee5-a484-714eaa556b83