Partner Channel Templates

A PartnerChannelTemplate defines reusable Partner Channel configuration that can be applied to Partners.

List Partner Channel Templates

SDK Method

PartnerChannelTemplate.List();

Return Object

FilesList<PartnerChannelTemplate>

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 partnerChannelTemplateIterator = PartnerChannelTemplate.List();
    foreach (PartnerChannelTemplate partnerChannelTemplate in partnerChannelTemplateIterator.ListAutoPaging()) {
        // Operate on partnerChannelTemplate
    }
}
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 Partner Channel Template

SDK Method

PartnerChannelTemplate.Find();

Return Object

PartnerChannelTemplate

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		Partner Channel Template ID.

Example Request

using FilesCom.Models;

try
{
    var partnerChannelTemplate = await PartnerChannelTemplate.Find(id);
    // Operate on partnerChannelTemplate
}
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 Partner Channel Template

SDK Method

PartnerChannelTemplate.Create();

Return Object

PartnerChannelTemplate

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
direction
string		"two_way"Channel directions. two_way enables both directions, to_partner enables outgoing downloads, and from_partner enables incoming uploads.
Possible values: two_way, to_partner, from_partner
from_partner_folder_name
string		Optional Channel-level from-Partner folder name override.
from_partner_managed_folder_paths
array(string)		Managed folder paths inside the from-Partner folder.
from_partner_route_path_pattern
string		Optional route path pattern for files uploaded by the Partner. Supports {{partner_name}}.
to_partner_folder_name
string		Optional Channel-level to-Partner folder name override.
to_partner_managed_folder_paths
array(string)		Managed folder paths inside the to-Partner folder.
to_partner_route_path_pattern
string		Optional route path pattern for files delivered to the Partner. Supports {{partner_name}}.
name
string
Required		The name of the Partner Channel Template.
path
string
Required		Channel path relative to the Partner root folder.
workspace_id
int64		0ID of the Workspace associated with this Partner Channel Template.

Example Request

using FilesCom.Models;

var parameters = new Dictionary<string, object>();
parameters.Add("name", "Claims Template");
parameters.Add("path", "claims/medical");

try
{
    var partnerChannelTemplate = await PartnerChannelTemplate.Create(parameters);
    // Operate on partnerChannelTemplate
}
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 Partner Channel Template

SDK Method

partnerChannelTemplate.Update();

Return Object

PartnerChannelTemplate

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
direction
string		Channel directions. two_way enables both directions, to_partner enables outgoing downloads, and from_partner enables incoming uploads.
Possible values: two_way, to_partner, from_partner
from_partner_folder_name
string		Optional Channel-level from-Partner folder name override.
from_partner_managed_folder_paths
array(string)		Managed folder paths inside the from-Partner folder.
from_partner_route_path_pattern
string		Optional route path pattern for files uploaded by the Partner. Supports {{partner_name}}.
to_partner_folder_name
string		Optional Channel-level to-Partner folder name override.
to_partner_managed_folder_paths
array(string)		Managed folder paths inside the to-Partner folder.
to_partner_route_path_pattern
string		Optional route path pattern for files delivered to the Partner. Supports {{partner_name}}.
name
string		The name of the Partner Channel Template.
path
string		Channel path relative to the Partner root folder.

Example Request

using FilesCom.Models;

var parameters = new Dictionary<string, object>();
parameters.Add("direction", "two_way");

try
{
    // Find the partnerChannelTemplate object by its id.
    var partnerChannelTemplate = await PartnerChannelTemplate.Find(id);
    await partnerChannelTemplate.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 Partner Channel Template

SDK Method

partnerChannelTemplate.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 partnerChannelTemplate object by its id.
    var partnerChannelTemplate = await PartnerChannelTemplate.Find(id);
    await partnerChannelTemplate.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 PartnerChannelTemplate Object

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

AttributeDescription
id
int64		The unique ID of the Partner Channel Template.
workspace_id
int64		ID of the Workspace associated with this Partner Channel Template.
direction
string		Channel directions. two_way enables both directions, to_partner enables outgoing downloads, and from_partner enables incoming uploads.
Possible values: two_way, to_partner, from_partner
name
string		The name of the Partner Channel Template.
path
string		Channel path relative to the Partner root folder. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
to_partner_folder_name
string		Optional Channel-level to-Partner folder name override.
from_partner_folder_name
string		Optional Channel-level from-Partner folder name override.
from_partner_route_path_pattern
string		Optional route path pattern for files uploaded by the Partner. Supports {{partner_name}}.
to_partner_route_path_pattern
string		Optional route path pattern for files delivered to the Partner. Supports {{partner_name}}.
to_partner_managed_folder_paths
array(string)		Managed folder paths inside the to-Partner folder.
from_partner_managed_folder_paths
array(string)		Managed folder paths inside the from-Partner folder.
effective_to_partner_folder_name
string		Resolved to-Partner folder name after Template override and default.
effective_from_partner_folder_name
string		Resolved from-Partner folder name after Template override and default.