Scheduled Exports

A Scheduled Export defines a recurring schedule for generating one of the built-in CSV exports and e-mailing it to a Site Admin recipient.

List Scheduled Exports

SDK Method

ScheduledExport.List();

Return Object

FilesList<ScheduledExport>

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Additional Arguments

Example Request

using FilesCom.Models;

try
{
    var scheduledExportIterator = ScheduledExport.List();
    foreach (ScheduledExport scheduledExport in scheduledExportIterator.ListAutoPaging()) {
        // Operate on scheduledExport
    }
}
catch (FilesCom.NotAuthenticatedException e)
{
    Console.WriteLine($"Authentication Error Occurred ({e.GetType().Name}): " + e.Message);
}
catch (FilesCom.SdkException e)
{
    Console.WriteLine($"Unknown Error Occurred ({e.GetType().Name}): " + e.Message);
}

Show Scheduled Export

SDK Method

ScheduledExport.Find();

Return Object

ScheduledExport

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
id
int64
Required		Scheduled Export ID.

Example Request

using FilesCom.Models;

try
{
    var scheduledExport = await ScheduledExport.Find(id);
    // Operate on scheduledExport
}
catch (FilesCom.NotAuthenticatedException e)
{
    Console.WriteLine($"Authentication Error Occurred ({e.GetType().Name}): " + e.Message);
}
catch (FilesCom.SdkException e)
{
    Console.WriteLine($"Unknown Error Occurred ({e.GetType().Name}): " + e.Message);
}

Create Scheduled Export

SDK Method

ScheduledExport.Create();

Return Object

ScheduledExport

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDefaultDescription
name
string
Required		Name for this scheduled export.
export_type
string
Required		Export report type. Valid values: folder_size_audit, group_membership_audit, permission_audit, share_link_audit
export_options
object		Report-specific options. permission_audit supports group_by with user or path.
user_id
int64		Site Admin user who receives the completed export e-mail.
disabled
boolean		falseIf true, this scheduled export will not run.
trigger
string		"daily"Schedule trigger type: daily or custom_schedule.
Possible values: daily, custom_schedule
interval
string		If trigger is daily, this specifies how often to run the scheduled export.
recurring_day
int64		If trigger is daily, this selects the day number inside the chosen interval.
recurring_days
array(int64)		If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
schedule_id
int64		If trigger is custom_schedule, the reusable Schedule used instead of the scheduled export's schedule fields.
schedule_days_of_week
array(int64)		If trigger is custom_schedule, the 0-based weekdays used by the schedule.
schedule_times_of_day
array(string)		Times of day in HH:MM format for the scheduled export schedule.
schedule_time_zone
string		Time zone used by the scheduled export schedule.
holiday_region
string		Optional holiday region used by the scheduled export schedule.

Example Request

using FilesCom.Models;

var parameters = new Dictionary<string, object>();
parameters.Add("name", "Monthly access review");
parameters.Add("export_type", "permission_audit");

try
{
    var scheduledExport = await ScheduledExport.Create(parameters);
    // Operate on scheduledExport
}
catch (FilesCom.NotAuthenticatedException e)
{
    Console.WriteLine($"Authentication Error Occurred ({e.GetType().Name}): " + e.Message);
}
catch (FilesCom.SdkException e)
{
    Console.WriteLine($"Unknown Error Occurred ({e.GetType().Name}): " + e.Message);
}

Update Scheduled Export

SDK Method

scheduledExport.Update();

Return Object

ScheduledExport

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
name
string		Name for this scheduled export.
export_type
string		Export report type. Valid values: folder_size_audit, group_membership_audit, permission_audit, share_link_audit
export_options
object		Report-specific options. permission_audit supports group_by with user or path.
user_id
int64		Site Admin user who receives the completed export e-mail.
disabled
boolean		If true, this scheduled export will not run.
trigger
string		Schedule trigger type: daily or custom_schedule.
Possible values: daily, custom_schedule
interval
string		If trigger is daily, this specifies how often to run the scheduled export.
recurring_day
int64		If trigger is daily, this selects the day number inside the chosen interval.
recurring_days
array(int64)		If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
schedule_id
int64		If trigger is custom_schedule, the reusable Schedule used instead of the scheduled export's schedule fields.
schedule_days_of_week
array(int64)		If trigger is custom_schedule, the 0-based weekdays used by the schedule.
schedule_times_of_day
array(string)		Times of day in HH:MM format for the scheduled export schedule.
schedule_time_zone
string		Time zone used by the scheduled export schedule.
holiday_region
string		Optional holiday region used by the scheduled export schedule.

Example Request

using FilesCom.Models;

var parameters = new Dictionary<string, object>();
parameters.Add("name", "Monthly access review");

try
{
    // Find the scheduledExport object by its id.
    var scheduledExport = await ScheduledExport.Find(id);
    await scheduledExport.Update(parameters);
}
catch (FilesCom.NotAuthenticatedException e)
{
    Console.WriteLine($"Authentication Error Occurred ({e.GetType().Name}): " + e.Message);
}
catch (FilesCom.SdkException e)
{
    Console.WriteLine($"Unknown Error Occurred ({e.GetType().Name}): " + e.Message);
}

Delete Scheduled Export

SDK Method

scheduledExport.Delete();

Return Object

No return value.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Example Request

using FilesCom.Models;

try
{
    // Find the scheduledExport object by its id.
    var scheduledExport = await ScheduledExport.Find(id);
    await scheduledExport.Delete();
}
catch (FilesCom.NotAuthenticatedException e)
{
    Console.WriteLine($"Authentication Error Occurred ({e.GetType().Name}): " + e.Message);
}
catch (FilesCom.SdkException e)
{
    Console.WriteLine($"Unknown Error Occurred ({e.GetType().Name}): " + e.Message);
}

The ScheduledExport Object

Some of the methods above return a ScheduledExport object. The attributes of this object are listed below.

AttributeDescription
id
int64		Scheduled Export ID
name
string		Name for this scheduled export.
export_type
string		Export report type. Valid values: folder_size_audit, group_membership_audit, permission_audit, share_link_audit
report_name
string		Human-readable report name.
export_options
object		Report-specific options. permission_audit supports group_by with user or path.
user_id
int64		Site Admin user who receives the completed export e-mail.
disabled
boolean		If true, this scheduled export will not run.
trigger
string		Schedule trigger type: daily or custom_schedule.
Possible values: daily, custom_schedule
interval
string		If trigger is daily, this specifies how often to run the scheduled export.
recurring_day
int64		If trigger is daily, this selects the day number inside the chosen interval.
recurring_days
array(int64)		If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
schedule_id
int64		If trigger is custom_schedule, the reusable Schedule used instead of the scheduled export's schedule fields.
schedule_days_of_week
array(int64)		If trigger is custom_schedule, the 0-based weekdays used by the schedule.
schedule_times_of_day
array(string)		Times of day in HH:MM format for the scheduled export schedule.
schedule_time_zone
string		Time zone used by the scheduled export schedule.
holiday_region
string		Optional holiday region used by the scheduled export schedule.
human_readable_schedule
string		Human-readable schedule description.
last_run_at
date-time		Most recent scheduled run time.
last_export_id
int64		Most recent Export ID created by this schedule.
created_at
date-time		Creation time.
updated_at
date-time		Last update time.