Manage Batch Export

Updates, delete or get batch export details

Note: To use this API, you must enable the Batch Exports Add-on and have the REPORTS_MANAGE permission assigned.

Get details of a batch export configuration

Path Parameters

  • partnerIdstringrequired

  • idstringrequired

Responses

  • idstring

    Batch export uuid

  • namestring

    Batch export configuration name

  • allClientsboolean

  • clientsarray

  • categoryTypestring

  • exportIntegrationobject

    Integration details

  • recurringTypestring

  • scheduleTypestring

  • startHoursstring

  • startMinutesstring

  • createdTimestring

  • updatedTimestring

  • dayOfMonthstring

  • createdByobject

    created by

  • updatedByobject

    last updated by

  • isFailureExportNotificationboolean

Loading Examples...

Note: To use this API, you must enable the Batch Exports Add-on. You also need to have the REPORTS_MANAGE and INTEGRATION_EDIT permissions assigned.

Update batch export configuration

Path Parameters

  • partnerIdstringrequired

  • idstringrequired

Request Body

application/json

  • namestringrequired

    Batch Export Name

  • allClientsbooleanrequired

    Enable all clients

  • clientstring

    Specific client list

  • scheduleTypestringrequired

    Scheduler type

    Enum:
    RECURRINGON-DEMAND

    Default: ON-DEMAND

  • categoryTypestringrequired

    Batch export type

    Enum:
    AlertsAuditUsageIntegrationsMetricsInventory
  • recurringTypestring

    Recurring type to be used only when recurring configuration is done.

    Enum:
    WeeklyMonthlyDaily

    Default: Monthly

  • exportIntegrationobjectrequired

    Integration associated

  • isFailureExportNotificationboolean

    Enable failed export notification

  • dayOfMonthstring

    Scheduled day of month. To be used only for Monthly Recurring configuration.Use any values between 1 to 27 and 'last'.

    Enum:
    last12

    Default: last

  • dayOfWeekstring

    Scheduled week. To be used only for Weekly Recurring configurations.

    Enum:
    SUNMONTUEWEDTHUFRISAT
  • startHoursstring

    Scheduled hour. To be used during Recurring configurations.

  • startMinutesstring

    Scheduled minute. To be used during Recurring configurations.

Loading Examples...

Responses

  • idstring

Loading Examples...

Note: To use this API, you need to have the INTEGRATION_MANAGE permission assigned.

Delete existing barch export configuration

Path Parameters

  • partnerIdstringrequired

  • idstringrequired

Responses

  • resultstring

Loading Examples...