Partner Channel Templates

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

Route path patterns can be fixed paths shared by all assigned Partners, or include {{partner_name}} to expand to a single folder name. Slashes in Partner names become pipes (|). Leading and trailing whitespace, percent signs, and null bytes are percent-encoded. Names consisting of . or .. become %2E or %2E%2E. For example, a Partner named "Acme " uses the folder "Acme%20", while "Acme%20" uses "Acme%2520". These percent sequences are literal folder-name characters, not URL encoding to decode. The expanded route must point to an existing folder in the same Workspace.

List Partner Channel Templates

SDK Method

Files::PartnerChannelTemplate.list

Return Object

List<PartnerChannelTemplate>

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator or a Workspace Administrator for the relevant workspace.

Additional Arguments

Example Request

begin
  partner_channel_templates = Files::PartnerChannelTemplate.list
  partner_channel_templates.auto_paging_each do |partner_channel_template|
    # Operate on partner_channel_template
  end
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Show Partner Channel Template

SDK Method

Files::PartnerChannelTemplate.find

Return Object

PartnerChannelTemplate

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator or a Workspace Administrator for the relevant workspace.

Method Arguments

ArgumentDescription
id
int64
Required		Partner Channel Template ID.

Example Request

begin
  partner_channel_template = Files::PartnerChannelTemplate.find(id)
  # Operate on partner_channel_template
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Create Partner Channel Template

SDK Method

Files::PartnerChannelTemplate.create

Return Object

PartnerChannelTemplate

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator or a Workspace Administrator for the relevant workspace.

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
use_channel_root
boolean		falseUse the Channel folder directly for a one-way exchange. Defaults to false. Cannot be changed after creation. Folder name overrides must be blank when enabled, and the Template must remain one-way.
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

begin
  partner_channel_template = Files::PartnerChannelTemplate.create(
    name: "Claims Template",
    path: "claims/medical"
  )
  # Operate on partner_channel_template
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Update Partner Channel Template

SDK Method

partner_channel_template.update

Return Object

PartnerChannelTemplate

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator or a Workspace Administrator for the relevant workspace.

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
use_channel_root
boolean		Use the Channel folder directly for a one-way exchange. Defaults to false. Cannot be changed after creation. Folder name overrides must be blank when enabled, and the Template must remain one-way.
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

begin
  # Find the partner_channel_template object by its id.
  partner_channel_template = Files::PartnerChannelTemplate.find(id)
  partner_channel_template.update(
    direction: "two_way"
  )
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Delete Partner Channel Template

SDK Method

partner_channel_template.delete

Return Object

nil

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator or a Workspace Administrator for the relevant workspace.

Example Request

begin
  # Find the partner_channel_template object by its id.
  partner_channel_template = Files::PartnerChannelTemplate.find(id)
  partner_channel_template.delete
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

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
use_channel_root
boolean		Use the Channel folder directly for a one-way exchange. Defaults to false. Cannot be changed after creation. Folder name overrides must be blank when enabled, and the Template must remain one-way.
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 subfolder name. Null when the direction is disabled or uses the Channel folder directly.
effective_from_partner_folder_name
string		Resolved from-Partner subfolder name. Null when the direction is disabled or uses the Channel folder directly.