Create On-Demand Batch Export Template

Creates an on-demand batch export template.

Batch Export Template

Path Parameters

  • tenantIdstringrequired

    Describes clientId or partnerId

Request Body

application/json

  • namestringrequired

    Name of the batch export template.

  • scheduleTypestringrequired

    Defines the schedule type. Example: ON-DEMAND.

    Enum:
    ON-DEMANDRECURRING
  • recurringTypestringrequired

    Defines the recurring type of batch export. Supported values: Daily, Weekly, Monthly.

    Enum:
    DailyWeeklyMonthly
  • integrationIdstringrequired

    Integration ID.

  • typestringrequired

    Defines the batch type to export. Supported values: Inventory, Alerts, Tickets, Metrics.

    Enum:
    InventoryAlertsTicketsMetrics
  • startHoursstring

    Defines the starting time of daily recurring in hours. Supported values: 00 to 23.

  • startMinsstring

    Defines the starting time of daily recurrence in minutes. Supported values: 00 to 59.

  • startDatestring

    Defines the starting date of monthly recurrence of batch export. Supported values: 01st to 27th or last day of the month.

  • startDaystring

    Defines the starting day of the weekly recurrence of batch export. Supported values: SUN, MON, TUE, WED, THU, FRI, SAT.

    Enum:
    SUNMONTUEWEDTHUFRISAT
Loading Examples...

Responses

200OK

Loading Examples...