Endpoint
/api/v2/exports/tenants/{tenantId}/create
Path Parameters
tenantIdstring
integrationIdstring
Integration ID.
namestring
Name of the batch export template.
recurringTypestring
Defines the recurring type of batch export. Supported values: Daily, Weekly, Monthly.
scheduleTypestring
Defines the schedule type. Example: ON-DEMAND.
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.
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.
typestring
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