Endpoint
/api/v2/exports/tenants/{tenantId}/create
Path Parameters
tenantId
string

integrationId
string

Integration ID.

name
string

Name of the batch export template.

recurringType
string

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

scheduleType
string

Defines the schedule type. Example: ON-DEMAND.

startDate
string

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

startDay
string

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

startHours
string

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

startMins
string

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

type
string

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

{
  "integrationId": "INTG-b0975fb4-e54e-4a80-a65f-883bf1109aa1",
  "name": "API Test Inventory",
  "recurringType": "Daily",
  "scheduleType": "ON-DEMAND",
  "type": "Inventory"
}
{
  "integrationId": "INTG-b0975fb4-e54e-4a80-a65f-883bf1109aa1",
  "name": "API Test Inventory",
  "recurringType": "Daily",
  "scheduleType": "ON-DEMAND",
  "type": "Inventory"
}
{
  "integrationId": "INTG-b0975fb4-e54e-4a80-a65f-883bf1109aa1",
  "name": "API Test Inventory",
  "recurringType": "Monthly",
  "scheduleType": "RECURRING",
  "startDate": "21st",
  "startHours": "02",
  "startMins": "04",
  "type": "Inventory"
}
{
  "integrationId": "INTG-b0975fb4-e54e-4a80-a65f-883bf1109aa1",
  "name": "API Test Inventory",
  "recurringType": "Weekly",
  "scheduleType": "RECURRING",
  "startDay": "TUE",
  "startHours": "02",
  "startMins": "04",
  "type": "Inventory"
}

Responses

OK

"Export template created for client_9 with id : schexp-4154945d-9efb-4cdc-bffc-ed9237168662,\nExport template created for client_12 with id : schexp-445f0e02-8cb2-4225-94c0-6e2f5ac1f360,\nExport template already exists for client_4"