Partner Channel Templates

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

List Partner Channel Templates

SDK Function

PartnerChannelTemplate.list()

Return Object

ListIterator<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

import com.files.ListIterator;
import com.files.exceptions.*;
import com.files.exceptions.ApiErrorException.*;
import com.files.models.PartnerChannelTemplate;

try {
  HashMap<String, Object> parameters = new HashMap<>();
  ListIterator<PartnerChannelTemplate> partnerChannelTemplates = PartnerChannelTemplate.list(parameters);
  for (PartnerChannelTemplate partnerChannelTemplate : partnerChannelTemplates.listAutoPaging()) {
    // Operate on partnerChannelTemplate
  }
} catch (NotAuthenticatedException e) {
  System.out.println("Authentication Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
} catch (SdkException e) {
  System.out.println("Unknown Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
}

Show Partner Channel Template

SDK Function

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.

Function Arguments

ArgumentDescription
id
int64
Required		Partner Channel Template ID.

Example Request

import com.files.exceptions.*;
import com.files.exceptions.ApiErrorException.*;
import com.files.models.PartnerChannelTemplate;

try {
  HashMap<String, Object> parameters = new HashMap<>();
  PartnerChannelTemplate partnerChannelTemplate = PartnerChannelTemplate.find(id, parameters);
  // Operate on partnerChannelTemplate
} catch (NotAuthenticatedException e) {
  System.out.println("Authentication Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
} catch (SdkException e) {
  System.out.println("Unknown Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
}

Create Partner Channel Template

SDK Function

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.

Function 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

import com.files.exceptions.*;
import com.files.exceptions.ApiErrorException.*;
import com.files.models.PartnerChannelTemplate;

try {
  HashMap<String, Object> parameters = new HashMap<>();
  parameters.put("name", "Claims Template");
  parameters.put("path", "claims/medical");
  
  PartnerChannelTemplate partnerChannelTemplate = PartnerChannelTemplate.create(parameters);
  // Operate on partnerChannelTemplate
} catch (NotAuthenticatedException e) {
  System.out.println("Authentication Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
} catch (SdkException e) {
  System.out.println("Unknown Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
}

Update Partner Channel Template

SDK Function

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.

Attribute Setters

SetterDescription
setDirection
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
setFromPartnerFolderName
string		Optional Channel-level from-Partner folder name override.
setFromPartnerManagedFolderPaths
array(string)		Managed folder paths inside the from-Partner folder.
setFromPartnerRoutePathPattern
string		Optional route path pattern for files uploaded by the Partner. Supports {{partner_name}}.
setToPartnerFolderName
string		Optional Channel-level to-Partner folder name override.
setToPartnerManagedFolderPaths
array(string)		Managed folder paths inside the to-Partner folder.
setToPartnerRoutePathPattern
string		Optional route path pattern for files delivered to the Partner. Supports {{partner_name}}.
setName
string		The name of the Partner Channel Template.
setPath
string		Channel path relative to the Partner root folder.

Example Request

import com.files.exceptions.*;
import com.files.exceptions.ApiErrorException.*;
import com.files.models.PartnerChannelTemplate;

try {
  // Find the partnerChannelTemplate object by its id.
  PartnerChannelTemplate partnerChannelTemplate = PartnerChannelTemplate.find(id, null);
  HashMap<String, Object> parameters = new HashMap<>();
  parameters.put("direction", "two_way");
  partnerChannelTemplate.update(parameters);
} catch (NotAuthenticatedException e) {
  System.out.println("Authentication Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
} catch (SdkException e) {
  System.out.println("Unknown Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
}

Delete Partner Channel Template

SDK Function

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

import com.files.exceptions.*;
import com.files.exceptions.ApiErrorException.*;
import com.files.models.PartnerChannelTemplate;

try {
  // Find the partnerChannelTemplate object by its id.
  PartnerChannelTemplate partnerChannelTemplate = PartnerChannelTemplate.find(id, null);
  partnerChannelTemplate.delete(null);
} catch (NotAuthenticatedException e) {
  System.out.println("Authentication Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
} catch (SdkException e) {
  System.out.println("Unknown Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
}

The PartnerChannelTemplate Object

Some of the functions 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.