Partner Channels
A PartnerChannel defines a structured communication path within a Partner root folder, including directional folder names and partner-scoped routing configuration.
Resource Schema
Required
| Property | Description |
|---|---|
| partner_id Int64 | ID of the Partner this Channel belongs to. |
| 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. |
Optional
| Property | Description |
|---|---|
| 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 |
| 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 List | Managed folder paths inside the to-Partner folder. |
| from_partner_managed_folder_paths List | Managed folder paths inside the from-Partner folder. |
Read Only
| Property | Description |
|---|---|
| id Int64 | The unique ID of the Partner Channel. |
| partner_channel_template_id Int64 | ID of the Partner Channel Template that manages this Channel, if any. |
| 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. |
Resource Import
This Resource supports importing using the following syntax:
Data Source Schema
Required
| Property | Description |
|---|---|
| id Int64 | The unique ID of the Partner Channel. |
Read Only
| Property | Description |
|---|---|
| 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 List | Managed folder paths inside the to-Partner folder. |
| from_partner_managed_folder_paths List | 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. |