Partner Channels

A PartnerChannel defines a structured communication path within a Partner root folder, including directional folder names and partner-scoped routing configuration.

List Partner Channels

SDK Function

PartnerChannel.list()

Return Object

ListIterator<PartnerChannel>

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.PartnerChannel;

try {
  HashMap<String, Object> parameters = new HashMap<>();
  ListIterator<PartnerChannel> partnerChannels = PartnerChannel.list(parameters);
  for (PartnerChannel partnerChannel : partnerChannels.listAutoPaging()) {
    // Operate on partnerChannel
  }
} 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

SDK Function

PartnerChannel.find()

Return Object

PartnerChannel

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 ID.

Example Request

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

try {
  HashMap<String, Object> parameters = new HashMap<>();
  PartnerChannel partnerChannel = PartnerChannel.find(id, parameters);
  // Operate on partnerChannel
} 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

SDK Function

PartnerChannel.create()

Return Object

PartnerChannel

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
string		Optional route path for files uploaded by the Partner.
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
string		Optional route path for files delivered to the Partner.
partner_id
int64
Required		ID of the Partner this Channel belongs to.
path
string
Required		Channel path relative to the Partner root folder.
workspace_id
int64		0ID of the Workspace associated with this Partner Channel.

Example Request

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

try {
  HashMap<String, Object> parameters = new HashMap<>();
  parameters.put("partner_id", 1);
  parameters.put("path", "claims/medical");
  
  PartnerChannel partnerChannel = PartnerChannel.create(parameters);
  // Operate on partnerChannel
} 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

SDK Function

partnerChannel.update();

Return Object

PartnerChannel

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.
setFromPartnerRoutePath
string		Optional route path for files uploaded by the Partner.
setToPartnerFolderName
string		Optional Channel-level to-Partner folder name override.
setToPartnerManagedFolderPaths
array(string)		Managed folder paths inside the to-Partner folder.
setToPartnerRoutePath
string		Optional route path for files delivered to the Partner.
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.PartnerChannel;

try {
  // Find the partnerChannel object by its id.
  PartnerChannel partnerChannel = PartnerChannel.find(id, null);
  HashMap<String, Object> parameters = new HashMap<>();
  parameters.put("direction", "two_way");
  partnerChannel.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

SDK Function

partnerChannel.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.PartnerChannel;

try {
  // Find the partnerChannel object by its id.
  PartnerChannel partnerChannel = PartnerChannel.find(id, null);
  partnerChannel.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 PartnerChannel Object

Some of the functions above return a PartnerChannel object. The attributes of this object are listed below.

AttributeDescription
id
int64		The unique ID of the Partner Channel.
workspace_id
int64		ID of the Workspace associated with this Partner Channel.
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
partner_id
int64		ID of the Partner this Channel belongs to.
partner_channel_template_id
int64		ID of the Partner Channel Template that manages this Channel, if any.
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
string		Optional route path for files uploaded by the Partner.
to_partner_route_path
string		Optional route path for files delivered to the Partner.
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 Channel override and default.
effective_from_partner_folder_name
string		Resolved from-Partner folder name after Channel override and default.
channel_path
string		Resolved Channel folder path.
to_partner_folder_path
string		Resolved to-Partner folder path.
from_partner_folder_path
string		Resolved from-Partner folder path.