The Portal Connector (TPC) is the leading alternative for delivering Customer Engagement portals connected to Microsoft Dynamics 365. The TPC Portal Connector enables organizations and businesses to capture triggers based on the interaction of portal users within The Portal Connector. The Connector also enables administrators to execute actions within The Portal Connector like assigning roles, creating content, and managing common processes.
Status: Preview |
Tier: Premium |
Version: 1.0 |
Name |
Summary |
Create Content |
|
Delete Content |
|
Edit Content |
|
Get All Content |
|
Get Content |
|
Sync Metadata |
|
Publish Content |
|
Create Portal User |
|
Edit Portal User |
|
Get Portal User |
|
Delete Portal User |
|
Get All Portal Users |
|
Assign Role |
|
Unassign Role |
|
Unpublish Content |
|
Lockout User |
|
Unlock User |
|
Retrieve Content Types |
|
Resolve Content Schema |
|
Retrieve Pages |
|
Unsubscribe Trigger |
Name |
Summary |
Login |
|
Logout |
|
Comment Created |
|
Comment Updated |
|
Comment Deleted |
|
Content Created |
|
Content Updated |
|
Content Deleted |
|
Form Entry Created |
|
Form Entry Updated |
|
TPC Knowledge Search |
|
Page Navigation |
|
Portal User Created |
|
Portal User Updated |
|
Portal User Deleted |
|
Role Assigned |
|
Role Unassigned |
|
Search |
|
TPC Form Submission |
|
User Created |
|
User Updated |
|
User Deleted |
Summary: Create Content
Description: Create content on the portal site.
Syntax:
TPCPortal.TpcActionCreateContent (pavliks.PortalConnector.PowerPlatform.Models.Services.Actions.Sitefinity.Content.Request.InitiateCreateContentRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
Request Object that is Used to Initiate Create Content requests on the Portal Site. |
True |
Returns:
Type:TpcActionCreateContentResponse
Summary: Delete Content
Description: Delete content on the portal site.
Syntax:
TPCPortal.TpcActionDeleteContent (pavliks.PortalConnector.PowerPlatform.Models.Services.Actions.Sitefinity.Content.Request.InitiateDeleteContentRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
Request Object that is Used to Initiate Delete Content requests on the Portal Site. |
True |
Returns:
Type:TpcActionDeleteContentResponse
Summary: Edit Content
Description: Edit content on the portal site.
Syntax:
TPCPortal.TpcActionEditContent (pavliks.PortalConnector.PowerPlatform.Models.Services.Actions.Sitefinity.Content.Request.InitiateEditContentRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
Request Object that is Used to Initiate Edit Content requests on the Portal Site. |
True |
Returns:
Type:TpcActionEditContentResponse
Summary: Get All Content
Description: Get all content on the portal site.
Syntax:
TPCPortal.TpcActionGetAllContent (pavliks.PortalConnector.PowerPlatform.Models.Services.Actions.Sitefinity.Content.Request.InitiateGetAllContentRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
Request Object that is Used to Initiate Get All Content requests on the Portal Site. |
True |
Returns:
Type:TpcActionGetAllContentResponse
Summary: Get Content
Description: Get content on the portal site.
Syntax:
TPCPortal.TpcActionGetContent (pavliks.PortalConnector.PowerPlatform.Models.Services.Actions.Sitefinity.Content.Request.InitiateGetContentRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
Request Object that is Used to Initiate Get Content requests on the Portal Site. |
True |
Returns:
Type:TpcActionGetContentResponse
Summary: Sync Metadata
Description: Trigger a metadata sync on the portal site.
Syntax:
TPCPortal.TpcActionSyncMetadata ()
Returns:
Type:pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.PortalResponse
Description: Generic Portal Response Message.
Summary: Publish Content
Description: Publish content on the portal site.
Syntax:
TPCPortal.TpcActionPublishContent (pavliks.PortalConnector.PowerPlatform.Models.Services.Actions.Sitefinity.Content.Request.InitiatePublishContentRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
Request Object that is Used to Initiate Publish Content requests on the Portal Site. |
True |
Returns:
Type:TpcActionPublishContentResponse
Summary: Create Portal User
Description: Create a portal user on the portal site.
Syntax:
TPCPortal.TpcActionCreatePortalUser (pavliks.PortalConnector.PowerPlatform.Models.Engine.Operations.TPC.PortalUser.PortalUserInfoCreate body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
pavliks.PortalConnector.PowerPlatform.Models.Engine.Operations.TPC.PortalUser.PortalUserInfoCreate
|
Object that is used to hold portal user information for create. |
True |
Returns:
Description: Portal User Response Message.
Summary: Edit Portal User
Description: Edit a portal user on the portal site.
Syntax:
TPCPortal.TpcActionEditPortalUser (pavliks.PortalConnector.PowerPlatform.Models.Engine.Operations.TPC.PortalUser.PortalUserInfoEdit body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
pavliks.PortalConnector.PowerPlatform.Models.Engine.Operations.TPC.PortalUser.PortalUserInfoEdit
|
Object that is used to hold portal user information for edit. |
True |
Returns:
Description: Portal User Response Message.
Summary: Get Portal User
Description: Get a portal user on the portal site.
Syntax:
TPCPortal.TpcActionGetPortalUser (pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.Content.TPC.PortalUser.SelectPortalUserParameters body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
Object that is used to help select a portal user item. In future iterations this object may also be used to add filtering criteria. |
True |
Returns:
Description: Portal User Response Message.
Summary: Delete Portal User
Description: Deletes a portal user on the portal site.
Syntax:
TPCPortal.TpcActionDeletePortalUser (pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.Content.TPC.PortalUser.SelectPortalUserParameters body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
Object that is used to help select a portal user item. In future iterations this object may also be used to add filtering criteria. |
True |
Returns:
Type:pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.PortalResponse
Description: Generic Portal Response Message.
Summary: Get All Portal Users
Description: Get all portal users on the portal site.
Syntax:
TPCPortal.TpcActionGetAllPortalUsers ()
Returns:
Description: Portal Users Response Message.
Summary: Assign Role
Description: Assign a role to a sitefinity user on the portal site.
Syntax:
TPCPortal.TpcActionAssignRole (pavliks.PortalConnector.PowerPlatform.Models.Services.Actions.Sitefinity.Role.Request.InitiateRoleActionRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
Request Used to Initiate a Role Action. |
True |
Returns:
Description: User-Role Portal Response Message.
Summary: Unassign Role
Description: Unassign a role from a sitefinity user on the portal site.
Syntax:
TPCPortal.TpcActionUnassignRole (pavliks.PortalConnector.PowerPlatform.Models.Services.Actions.Sitefinity.Role.Request.InitiateRoleActionRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
Request Used to Initiate a Role Action. |
True |
Returns:
Description: User-Role Portal Response Message.
Summary: Unpublish Content
Description: Unpublish content on the portal site.
Syntax:
TPCPortal.TpcActionUnpublishContent (pavliks.PortalConnector.PowerPlatform.Models.Services.Actions.Sitefinity.Content.Request.InitiateUnpublishContentRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
Request Object that is Used to Initiate Unpublish Content requests on the Portal Site. |
True |
Returns:
Type:TpcActionUnpublishContentResponse
Summary: Lockout User
Description: Lockout a user on the portal site.
Syntax:
TPCPortal.TpcActionLockoutUser (pavliks.PortalConnector.PowerPlatform.Models.Services.Actions.Sitefinity.User.Request.InitiateUserActionRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
Request Used to Initiate a User Action. |
True |
Returns:
Description: User Portal Response Message.
Summary: Unlock User
Description: Unlock a user on the portal site.
Syntax:
TPCPortal.TpcActionUnlockUser (pavliks.PortalConnector.PowerPlatform.Models.Services.Actions.Sitefinity.User.Request.InitiateUserActionRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
Request Used to Initiate a User Action. |
True |
Returns:
Description: User Portal Response Message.
Summary: Retrieve Content Types
Description: Retrieve a list of all content types on the portal site.
Syntax:
TPCPortal.TpcDynamicRetrieveContentTypes (pavliks.PortalConnector.PowerPlatform.Models.Services.Actions.Generic.Types.Request.TypesRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
pavliks.PortalConnector.PowerPlatform.Models.Services.Actions.Generic.Types.Request.TypesRequest
|
Request Object that is Used to Request Types |
True |
Returns:
Description: Types Portal Response Message.
Summary: Resolve Content Schema
Description: Resolve a content schema for a specific content type of the portal site.
Syntax:
TPCPortal.TpcDynamicResolveContentSchema (pavliks.PortalConnector.PowerPlatform.Models.Services.Actions.Generic.Schema.Request.SchemaRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
pavliks.PortalConnector.PowerPlatform.Models.Services.Actions.Generic.Schema.Request.SchemaRequest
|
Request Object that is Used to Request a Dynamic Schema |
True |
Returns:
Type:pavliks.PortalConnector.PowerPlatform.Models.Services.Actions.Generic.Schema.Response.SchemaResponse
Description: Object that is used to return a dynamic schema response.
Summary: Retrieve Pages
Description: Retrieve a list of all frontend pages on the portal site.
Syntax:
TPCPortal.TpcDynamicRetrieveFrontendPages ()
Returns:
Description: Page Nodes Portal Response Message.
Summary: Unsubscribe Trigger
Description: Deletes a web hook subscription for a trigger.
Syntax:
TPCPortal.TpcTriggerDelete (string id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
id |
string
|
Id of the Web Hook to be Deleted |
True |
Returns:
Type:pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.PortalResponse
Description: Generic Portal Response Message.
Summary: Login
Description: Subscribes to the login event.
Syntax:
TPCPortal.TpcTriggerLogin (pavliks.PortalConnector.PowerPlatform.Models.Services.Triggers.Sitefinity.Authentication.Request.SubscribeLoginRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
Request object that is used to subscribe for a Login on a Portal site |
True |
Returns:
Type:pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.PortalResponse
Description: Generic Portal Response Message.
Summary: Logout
Description: Subscribes to the logout event.
Syntax:
TPCPortal.TpcTriggerLogout (pavliks.PortalConnector.PowerPlatform.Models.Services.Triggers.Sitefinity.Authentication.Request.SubscribeLogoutRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
Request object that is used to subscribe for a logout on a portal site. |
True |
Returns:
Type:pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.PortalResponse
Description: Generic Portal Response Message.
Summary: Comment Created
Description: Subscribes to the comment created event.
Syntax:
TPCPortal.TpcTriggerCommentCreated (pavliks.PortalConnector.PowerPlatform.Models.Services.Triggers.Sitefinity.Comment.Request.SubscribeCommentRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
Request object that is used to subscribe for a comment event on a portal site |
True |
Returns:
Type:pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.PortalResponse
Description: Generic Portal Response Message.
Summary: Comment Updated
Description: Subscribes to the comment updated event.
Syntax:
TPCPortal.TpcTriggerCommentUpdated (pavliks.PortalConnector.PowerPlatform.Models.Services.Triggers.Sitefinity.Comment.Request.SubscribeCommentRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
Request object that is used to subscribe for a comment event on a portal site |
True |
Returns:
Type:pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.PortalResponse
Description: Generic Portal Response Message.
Summary: Comment Deleted
Description: Subscribes to the comment deleted event.
Syntax:
TPCPortal.TpcTriggerCommentDeleted (pavliks.PortalConnector.PowerPlatform.Models.Services.Triggers.Sitefinity.Comment.Request.SubscribeCommentRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
Request object that is used to subscribe for a comment event on a portal site |
True |
Returns:
Type:pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.PortalResponse
Description: Generic Portal Response Message.
Summary: Content Created
Description: Subscribes to the content created event.
Syntax:
TPCPortal.TpcTriggerContentCreated (pavliks.PortalConnector.PowerPlatform.Models.Services.Triggers.Sitefinity.Content.Request.SubscribeContentRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
Request object that is used to subscribe for a Content event on a portal site |
True |
Returns:
Type:pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.PortalResponse
Description: Generic Portal Response Message.
Summary: Content Updated
Description: Subscribes to the content updated event.
Syntax:
TPCPortal.TpcTriggerContentUpdated (pavliks.PortalConnector.PowerPlatform.Models.Services.Triggers.Sitefinity.Content.Request.SubscribeContentRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
Request object that is used to subscribe for a Content event on a portal site |
True |
Returns:
Type:pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.PortalResponse
Description: Generic Portal Response Message.
Summary: Content Deleted
Description: Subscribes to the content deleted event.
Syntax:
TPCPortal.TpcTriggerContentDeleted (pavliks.PortalConnector.PowerPlatform.Models.Services.Triggers.Sitefinity.Content.Request.SubscribeContentRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
Request object that is used to subscribe for a Content event on a portal site |
True |
Returns:
Type:pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.PortalResponse
Description: Generic Portal Response Message.
Summary: Form Entry Created
Description: Subscribes to the form entry created event.
Syntax:
TPCPortal.TpcTriggerFormEntryCreated (pavliks.PortalConnector.PowerPlatform.Models.Services.Triggers.Sitefinity.Form.Request.SubscribeFormEntryRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
Request object that is used to subscribe for a Form Entry on a Portal site |
True |
Returns:
Type:pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.PortalResponse
Description: Generic Portal Response Message.
Summary: Form Entry Updated
Description: Subscribes to the form entry updated event.
Syntax:
TPCPortal.TpcTriggerFormEntryUpdated (pavliks.PortalConnector.PowerPlatform.Models.Services.Triggers.Sitefinity.Form.Request.SubscribeFormEntryRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
Request object that is used to subscribe for a Form Entry on a Portal site |
True |
Returns:
Type:pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.PortalResponse
Description: Generic Portal Response Message.
Summary: TPC Knowledge Search
Description: Subscribes to the TPC knowledge search event.
Syntax:
TPCPortal.TpcTriggerKnowledgeSearch (pavliks.PortalConnector.PowerPlatform.Models.Services.Triggers.TPC.Search.Request.SubscribeKnowledgeSearchRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
Request object that is used to subscribe for a TPC knowledge search on a portal site. |
True |
Returns:
Type:pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.PortalResponse
Description: Generic Portal Response Message.
Summary: Page Navigation
Description: Subscribes to the page navigation event.
Syntax:
TPCPortal.TpcTriggerPageNavigation (pavliks.PortalConnector.PowerPlatform.Models.Services.Triggers.Sitefinity.Navigation.Request.SubscribePageNavigationRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
Request object that is used to subscribe for a Page Navigation on a Portal site |
True |
Returns:
Type:pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.PortalResponse
Description: Generic Portal Response Message.
Summary: Portal User Created
Description: Subscribes to a portal user created event.
Syntax:
TPCPortal.TpcTriggerPortalUserCreated (pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.Triggers.Request.PortalSubscribeRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.Triggers.Request.PortalSubscribeRequest
|
Request Object that is Used to Subscribe to a Portal Web Hook |
True |
Returns:
Type:pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.PortalResponse
Description: Generic Portal Response Message.
Summary: Portal User Updated
Description: Subscribes to a portal user updated event.
Syntax:
TPCPortal.TpcTriggerPortalUserUpdated (pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.Triggers.Request.PortalSubscribeRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.Triggers.Request.PortalSubscribeRequest
|
Request Object that is Used to Subscribe to a Portal Web Hook |
True |
Returns:
Type:pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.PortalResponse
Description: Generic Portal Response Message.
Summary: Portal User Deleted
Description: Subscribes to a portal user deleted event.
Syntax:
TPCPortal.TpcTriggerPortalUserDeleted (pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.Triggers.Request.PortalSubscribeRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.Triggers.Request.PortalSubscribeRequest
|
Request Object that is Used to Subscribe to a Portal Web Hook |
True |
Returns:
Type:pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.PortalResponse
Description: Generic Portal Response Message.
Summary: Role Assigned
Description: Subscribes to the role assigned event.
Syntax:
TPCPortal.TpcTriggerRoleAssigned (pavliks.PortalConnector.PowerPlatform.Models.Services.Triggers.Sitefinity.Role.Request.SubscribeRoleRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
Request object that is used to subscribe for a role action on a portal site. |
True |
Returns:
Type:pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.PortalResponse
Description: Generic Portal Response Message.
Summary: Role Unassigned
Description: Subscribes to the role unassigned event.
Syntax:
TPCPortal.TpcTriggerRoleUnassigned (pavliks.PortalConnector.PowerPlatform.Models.Services.Triggers.Sitefinity.Role.Request.SubscribeRoleRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
Request object that is used to subscribe for a role action on a portal site. |
True |
Returns:
Type:pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.PortalResponse
Description: Generic Portal Response Message.
Summary: Search
Description: Subscribes to the search event.
Syntax:
TPCPortal.TpcTriggerSearch (pavliks.PortalConnector.PowerPlatform.Models.Services.Triggers.Sitefinity.Search.Request.SubscribeSearchRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
Request object that is used to subscribe for a Sitefinity search on a portal site. |
True |
Returns:
Type:pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.PortalResponse
Description: Generic Portal Response Message.
Summary: TPC Form Submission
Description: Subscribes to the TPC form submission event.
Syntax:
TPCPortal.TpcTriggerFormSubmission (pavliks.PortalConnector.PowerPlatform.Models.Services.Triggers.TPC.Form.Request.SubscribeFormSubmissionRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
Request object that is used to subscribe for a form submission on a portal site. |
True |
Returns:
Type:pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.PortalResponse
Description: Generic Portal Response Message.
Summary: User Created
Description: Subscribes to a user created event.
Syntax:
TPCPortal.TpcTriggerUserCreated (pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.Triggers.Request.PortalSubscribeRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.Triggers.Request.PortalSubscribeRequest
|
Request Object that is Used to Subscribe to a Portal Web Hook |
True |
Returns:
Type:pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.PortalResponse
Description: Generic Portal Response Message.
Summary: User Updated
Description: Subscribes to a user updated event.
Syntax:
TPCPortal.TpcTriggerUserUpdated (pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.Triggers.Request.PortalSubscribeRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.Triggers.Request.PortalSubscribeRequest
|
Request Object that is Used to Subscribe to a Portal Web Hook |
True |
Returns:
Type:pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.PortalResponse
Description: Generic Portal Response Message.
Summary: User Deleted
Description: Subscribes to a user deleted event.
Syntax:
TPCPortal.TpcTriggerUserDeleted (pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.Triggers.Request.PortalSubscribeRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.Triggers.Request.PortalSubscribeRequest
|
Request Object that is Used to Subscribe to a Portal Web Hook |
True |
Returns:
Type:pavliks.PortalConnector.PowerPlatform.Models.Services.Shared.PortalResponse
Description: Generic Portal Response Message.
Summary:
Description: Object that is used to return readonly culture information.
Properties:
Name |
Type |
Summary |
_tpcDisplayName |
string Internal Display Name |
Internal display name. |
displayName |
string Display Name |
The fully localized culture name. |
isNeutralCulture |
boolean Is Neutral Culture |
Indicates whether this culture is neutral. Values: [true, false] |
isReadOnly |
boolean Is Read-Only |
Indicates whether or not this culture is read-only. Values: [true, false] |
lcid |
integer(int32) LCID |
Gets the culture identifier. |
name |
string Name |
Gets the culture name in the format languagecode2-country/regioncode2. |
Summary: Type:
Description: Object that is used to hold type information.
Properties:
Name |
Type |
Summary |
_tpcDisplayName |
string Internal Display Name |
Internal display name. |
versions |
array of (integer(int32)) Versions |
Internal revision numbers that this type are included in. |
displayName |
string Display Name |
Display name of the type. |
fullName |
string Full Name |
Full name of the type. |
userFriendlyName |
string User Friendly Name |
User friendly name of the type. |
Summary: Page Node:
Description: Object that is used to hold page node information.
Properties:
Name |
Type |
Summary |
_tpcDisplayName |
string Internal Display Name |
Internal display name. |
approvalWorkflowState |
string Approval Workflow State |
Gets or sets the current state of the item in the approval workflow. |
attributes |
Attributes |
Gets a dictionary of taxonomy attributes for this content. |
availableCultures |
array of (pavliks.PortalConnector.PowerPlatform.Models.Engine.Operations.Generic.Culture.CultureInfo) Available Cultures -> |
Gets cultures available for this item. |
availableLanguages |
array of (string) Available Languages |
Gets languages available for this item. |
crawlable |
boolean Crawlable |
Gets or sets a value indicating whether this page can be indexed by external search engines. Values: [true, false] |
description |
string Description |
Description of the content item. |
dateCreated |
string(date-time) Date Created |
The date on which the content was created. |
extension |
string Extension |
Gets or sets the extension to be used with the current page with the dot, ex .aspx, .html. |
id |
string(uuid) Id |
Unique identifier of the content. |
includeInSearchIndex |
boolean Include In Search Index |
Gets or sets a value indicating whether to exclude the page from the Sitefinity search engine. Values: [true, false] |
isBackend |
boolean Is Backend |
Gets a value indicating whether this node is a backend node. Values: [true, false] |
isSplitPage |
boolean Is Split Page |
Gets a value indicating whether this page is in split mode. Values: [true, false] |
lastModified |
string(date-time) Last Modified |
The date on which the content was last modified. |
localizationStrategy |
integer Localization Strategy |
Gets the localization strategy. Values: [, , ] |
moduleName |
string Module Name |
Gets or sets the name of the module that this page node depends on. |
name |
string Name |
Gets or sets the programmatic name of the page node. |
nodes |
array of (string(uuid)) Nodes |
Gets a list of child page nodes. |
nodeType |
integer Node Type |
Gets or sets the type of the page. Values: [, , , , , ] |
ordinal |
number(float) Ordinal |
Gets or sets the ordinal number. |
owner |
string(uuid) Owner |
User id of the owner of the content. |
pageId |
string(uuid) Page Id |
Gets the Id of the page data that is linked to the node. |
parentId |
string(uuid) Parent Id |
Gets or sets the parent node. |
redirectUrl |
string Redirect Url |
Gets or sets the URL where the client will be redirected to if the NodeType is set to Redirect. |
requireSsl |
boolean Require Ssl |
Gets or sets a value indicating whether this page requires SSL. Values: [true, false] |
showInNavigation |
boolean Show In Navigation |
Gets or sets a value indicating whether this page should be shown in the navigation. Values: [true, false] |
title |
string Title |
Gets or sets the title. |
urlName |
string Url Name |
Gets or sets the url name of the content item. |
urls |
array of (pavliks.PortalConnector.PowerPlatform.Models.Engine.Operations.Sitefinity.Url.UrlInfo) Urls -> |
Collection of url data for this content. |
Summary: Attributes
Description: Gets a dictionary of taxonomy attributes for this content.
Properties:
Name |
Type |
Summary |
Summary: Role:
Description: Object that is used to hold role information.
Properties:
Name |
Type |
Summary |
_tpcDisplayName |
string Internal Display Name |
Internal display name. |
id |
string(uuid) Id |
Unique identifier of the role. |
lastModified |
string(date-time) Last Modified |
Datetime on which the role was last modified. |
name |
string Name |
Name of the role. |
provider |
string Provider |
Provider of the role. |
Summary:
Description: Object that is used to return a readonly url information.
Properties:
Name |
Type |
Summary |
_tpcDisplayName |
string Internal Display Name |
Internal display name. |
disabled |
boolean Disabled |
Indicates whether or not this url is disabled. Values: [true, false] |
id |
string(uuid) Id |
Unique identifier of the url. |
lastModified |
string(date-time) Last Modified |
Date of the last time this url was modified. |
queryString |
string Query String |
The Query string for this url. |
url |
string URL |
The url value. |
Summary: User:
Description: Object that is used to hold user and profile information.
Properties:
Name |
Type |
Summary |
_tpcDisplayName |
string Internal Display Name |
Internal display name. |
comment |
string Comment |
Gets or sets application-specific information for the membership user. |
creationDate |
string(date-time) Creation Date |
The date on which the content was created. |
|
string |
Gets or sets the email address for the membership user. |
externalId |
string(uuid) External Id |
Gets or sets the user id in the external provider. |
externalProviderName |
string External Provider Name |
Gets or sets the external provider name. |
id |
string(uuid) Id |
Gets or sets the identifier of the user. |
isApproved |
boolean Is Approved |
Gets or sets whether the membership user can be authenticated. Values: [true, false] |
isBackendUser |
boolean Is BackendUser |
Gets or sets a value indicating whether this is a backend user. Values: [true, false] |
isLockedOut |
boolean Is Locked Out |
Gets a value indicating whether the membership user is locked out and unable to be validated. Values: [true, false] |
isLoggedIn |
boolean Is Logged In |
Gets or sets a value indicating whether the membership user is logged in. Values: [true, false] |
isOnline |
boolean Is Online |
Gets whether the user is currently online. Values: [true, false] |
lastLoginDate |
string(date-time) Last Login Date |
Gets or sets the date and time that the user was last authenticated. |
lastLoginIp |
string Last Login Ip |
Gets or sets the IP address of the last user login. |
lastModified |
string(date-time) Last Modified |
The date on which the content was last modified. |
passwordFormat |
integer(int32) Password Format |
Gets or sets the password format. |
passwordQuestion |
string Password Question |
Gets the password question for the membership user. |
providerName |
string Provider Name |
Gets the name of the membership provider that stores and retrieves user information for the user. |
userName |
string User Name |
Gets the username of the membership user. |
about |
string About |
Gets or sets a descriptive text about the user. |
avatar |
string(uuid) Avatar |
Gets or sets the image used as an avatar. |
dateCreated |
string(date-time) Date Created |
Gets the date and time the profile was created. |
firstName |
string First Name |
Gets or sets the users first name. |
lastName |
string Last Name |
Gets or sets the users last name. |
nickname |
string Nickname |
Gets or sets the nickname of the user. |
owner |
string(uuid) Owner |
Gets the identifier of the profiles user. |
sourceKey |
string Source Key |
Gets or sets a field that can be used for synchronization with external content systems. |
Summary: User:
Description: Object that is used to hold portal user and profile information.
Properties:
Name |
Type |
Summary |
_tpcDisplayName |
string Internal Display Name |
Internal display name. |
comment |
string Comment |
Gets or sets application-specific information for the membership user. |
creationDate |
string(date-time) Creation Date |
The date on which the content was created. |
|
string |
Gets or sets the email address for the membership user. |
externalId |
string(uuid) External Id |
Gets or sets the user id in the external provider. |
externalProviderName |
string External Provider Name |
Gets or sets the external provider name. |
id |
string(uuid) Id |
Gets or sets the identifier of the user. |
isApproved |
boolean Is Approved |
Gets or sets whether the membership user can be authenticated. Values: [true, false] |
isBackendUser |
boolean Is BackendUser |
Gets or sets a value indicating whether this is a backend user. Values: [true, false] |
isLockedOut |
boolean Is Locked Out |
Gets a value indicating whether the membership user is locked out and unable to be validated. Values: [true, false] |
isLoggedIn |
boolean Is Logged In |
Gets or sets a value indicating whether the membership user is logged in. Values: [true, false] |
isOnline |
boolean Is Online |
Gets whether the user is currently online. Values: [true, false] |
lastLoginDate |
string(date-time) Last Login Date |
Gets or sets the date and time that the user was last authenticated. |
lastLoginIp |
string Last Login Ip |
Gets or sets the IP address of the last user login. |
lastModified |
string(date-time) Last Modified |
The date on which the content was last modified. |
passwordFormat |
integer(int32) Password Format |
Gets or sets the password format. |
passwordQuestion |
string Password Question |
Gets the password question for the membership user. |
providerName |
string Provider Name |
Gets the name of the membership provider that stores and retrieves user information for the user. |
userName |
string User Name |
Gets the username of the membership user. |
about |
string About |
Gets or sets a descriptive text about the user. |
avatar |
string(uuid) Avatar |
Gets or sets the image used as an avatar. |
dateCreated |
string(date-time) Date Created |
Gets the date and time the profile was created. |
firstName |
string First Name |
Gets or sets the users first name. |
lastName |
string Last Name |
Gets or sets the users last name. |
nickname |
string Nickname |
Gets or sets the nickname of the user. |
owner |
string(uuid) Owner |
Gets the identifier of the profiles user. |
sourceKey |
string Source Key |
Gets or sets a field that can be used for synchronization with external content systems. |
crmContactId |
string(uuid) Crm Contact Id |
Gets or sets CRM contact id. |
crmParentCustomerId |
string(uuid) CRM Parent Customer Id |
Gets or sets CRM parent customer id. |
crmParentCustomerType |
string CRM Parent Customer Type |
Gets or sets CRM parent customer type (account, systemuser, etc). |
crmUserId |
string(uuid) CRM User Id |
Gets or sets CRM user id. |
crmContactPriceListId |
string(uuid) Crm Contact Price List Id |
Gets or sets CRM contact price list id. |
crmPortalUserId |
string(uuid) Crm Portal User Id |
Gets or sets CRM portal user id. |
Summary:
Description: Object that is used to hold portal user information for create.
Properties:
Name |
Type |
Summary |
comment |
string Comment |
Gets or sets application-specific information for the membership user. |
|
string |
Gets or sets the email address for the membership user. |
isApproved |
boolean Is Approved |
Gets or sets whether the membership user can be authenticated. Values: [true, false] |
isBackendUser |
boolean Is BackendUser |
Gets or sets a value indicating whether this is a backend user. Values: [true, false] |
password |
string Password |
Sets the password for the user. |
passwordAnswer |
string Password Answer |
Sets the password answer for the user. |
passwordQuestion |
string Password Question |
Gets the password question for the membership user. |
about |
string About |
Gets or sets a descriptive text about the user. |
firstName |
string First Name |
Gets or sets the users first name. |
lastName |
string Last Name |
Gets or sets the users last name. |
nickname |
string Nickname |
Gets or sets the nickname of the user. |
sourceKey |
string Source Key |
Gets or sets a field that can be used for synchronization with external content systems. |
crmContactId |
string(uuid) Crm Contact Id |
Gets or sets CRM contact id. |
crmUserId |
string(uuid) CRM User Id |
Gets or sets CRM user id. |
Summary:
Description: Object that is used to hold portal user information for edit.
Properties:
Name |
Type |
Summary |
comment |
string Comment |
Gets or sets application-specific information for the membership user. |
|
string |
Gets or sets the email address for the membership user. |
id |
string(uuid) Id |
Gets or sets the identifier of the user. |
isApproved |
boolean Is Approved |
Gets or sets whether the membership user can be authenticated. Values: [true, false] |
isBackendUser |
boolean Is BackendUser |
Gets or sets a value indicating whether this is a backend user. Values: [true, false] |
about |
string About |
Gets or sets a descriptive text about the user. |
firstName |
string First Name |
Gets or sets the users first name. |
lastName |
string Last Name |
Gets or sets the users last name. |
nickname |
string Nickname |
Gets or sets the nickname of the user. |
sourceKey |
string Source Key |
Gets or sets a field that can be used for synchronization with external content systems. |
crmContactId |
string(uuid) Crm Contact Id |
Gets or sets CRM contact id. |
crmUserId |
string(uuid) CRM User Id |
Gets or sets CRM user id. |
Summary:
Description: Request Object that is Used to Request a Dynamic Schema
Properties:
Name |
Type |
Summary |
fullName |
string Full Name |
Full name of the object that the schema is being requested for. |
operation |
integer Operation |
Operation to be performed on the object that the schema is being requested for. Values: [, , , , , , , , , ] |
phase |
integer Content Phase |
Phase (request or response) of the operation to be performed on the object that the schema is being requested for. Values: [, ] |
version |
integer(int32) Version |
Version that is used to filter the types. |
Summary:
Description: Object that is used to return a dynamic schema response.
Properties:
Name |
Type |
Summary |
status |
boolean Status |
Boolean that indicates whether the request failed (false) or succeeded (true). Values: [true, false] |
message |
string Message |
Message that summarizes the results of the request. |
timestamp |
string(date-time) Timestamp |
UTC timestamp of the response. |
typeFullName |
string Type Full Name |
Full name of the content type. |
typeDisplayName |
string Type Display Name |
Display name of the content type. |
requestFullName |
string Request Full Name |
Full name of the request object that will be used for the specified type and operation. |
requestDisplayName |
string Request Display Name |
Display name of the request object that will be used for the specified type and operation. |
schema |
Schema |
Schema object representing the request object for the specified type and operation. |
Summary: Schema
Description: Schema object representing the request object for the specified type and operation.
Properties:
Name |
Type |
Summary |
Summary:
Description: Request Object that is Used to Request Types
Properties:
Name |
Type |
Summary |
operation |
integer Operation |
Operation that is used to filter the types. Values: [, , , , , , , , , ] |
version |
integer(int32) Version |
Version that is used to filter the types. |
Summary:
Description: Request Object that is Used to Initiate Create Content requests on the Portal Site.
Properties:
Name |
Type |
Summary |
contentType |
string Content Type |
Content type of the create request. |
schema |
Schema |
Schema of the content create request. |
Summary: Schema
Description: Schema of the content create request.
Properties:
Name |
Type |
Summary |
Summary:
Description: Request Object that is Used to Initiate Delete Content requests on the Portal Site.
Properties:
Name |
Type |
Summary |
contentType |
string Content Type |
Content type of the content delete request. |
schema |
Schema |
Schema of the content delete request. |
Summary: Schema
Description: Schema of the content delete request.
Properties:
Name |
Type |
Summary |
Summary:
Description: Request Object that is Used to Initiate Edit Content requests on the Portal Site.
Properties:
Name |
Type |
Summary |
contentType |
string Content Type |
Content type of the edit request. |
schema |
Schema |
Schema of the content edit request. |
Summary: Schema
Description: Schema of the content edit request.
Properties:
Name |
Type |
Summary |
Summary:
Description: Request Object that is Used to Initiate Get All Content requests on the Portal Site.
Properties:
Name |
Type |
Summary |
contentType |
string Content Type |
Content type of the get all request. |
schema |
Schema |
Schema of the content get all request. |
Summary: Schema
Description: Schema of the content get all request.
Properties:
Name |
Type |
Summary |
Summary:
Description: Request Object that is Used to Initiate Get Content requests on the Portal Site.
Properties:
Name |
Type |
Summary |
contentType |
string Content Type |
Content type of the get request. |
schema |
Schema |
Schema of the content get request. |
Summary: Schema
Description: Schema of the content get request.
Properties:
Name |
Type |
Summary |
Summary:
Description: Request Object that is Used to Initiate Publish Content requests on the Portal Site.
Properties:
Name |
Type |
Summary |
contentType |
string Content Type |
Content type of the publish request. |
schema |
Schema |
Schema of the content publish request. |
Summary: Schema
Description: Schema of the content publish request.
Properties:
Name |
Type |
Summary |
Summary:
Description: Request Object that is Used to Initiate Unpublish Content requests on the Portal Site.
Properties:
Name |
Type |
Summary |
contentType |
string Content Type |
Content type of the unpublish request. |
schema |
Schema |
Schema of the content unpublish request. |
Summary: Schema
Description: Schema of the content unpublish request.
Properties:
Name |
Type |
Summary |
Summary:
Description: Request Used to Initiate a Role Action.
Properties:
Name |
Type |
Summary |
userId |
string(uuid) User Id |
The user that the role action will be performed on. |
roleId |
string(uuid) Role Id |
The role that the action will be performed with. |
Summary:
Description: Request Used to Initiate a User Action.
Properties:
Name |
Type |
Summary |
userId |
string(uuid) User Id |
User that the action will be performed on. |
Summary:
Description: Types Portal Response Message.
Properties:
Name |
Type |
Summary |
status |
boolean Status |
Boolean that indicates whether the request failed (false) or succeeded (true). Values: [true, false] |
message |
string Message |
Message that summarizes the results of the request. |
timestamp |
string(date-time) Timestamp |
UTC timestamp of the response. |
count |
integer(int32) Type Count |
Total number of supported types. |
items |
array of (pavliks.PortalConnector.PowerPlatform.Models.Engine.Operations.Generic.Types.TypeInfo) Types |
List of type information. |
Summary:
Description: User-Role Portal Response Message.
Properties:
Name |
Type |
Summary |
status |
boolean Status |
Boolean that indicates whether the request failed (false) or succeeded (true). Values: [true, false] |
message |
string Message |
Message that summarizes the results of the request. |
timestamp |
string(date-time) Timestamp |
UTC timestamp of the response. |
role |
pavliks.PortalConnector.PowerPlatform.Models.Engine.Operations.Sitefinity.Role.RoleInfo Role: |
Object that is used to hold role information. |
user |
pavliks.PortalConnector.PowerPlatform.Models.Engine.Operations.Sitefinity.User.UserInfo User: |
Object that is used to hold user and profile information. |
Summary:
Description: Page Nodes Portal Response Message.
Properties:
Name |
Type |
Summary |
status |
boolean Status |
Boolean that indicates whether the request failed (false) or succeeded (true). Values: [true, false] |
message |
string Message |
Message that summarizes the results of the request. |
timestamp |
string(date-time) Timestamp |
UTC timestamp of the response. |
count |
integer(int32) Page Nodes Count |
Total number of page node items. |
items |
array of (pavliks.PortalConnector.PowerPlatform.Models.Engine.Operations.Sitefinity.Page.PageNodeInfo) Page Nodes |
List of page nodes. |
Summary:
Description: User Portal Response Message.
Properties:
Name |
Type |
Summary |
status |
boolean Status |
Boolean that indicates whether the request failed (false) or succeeded (true). Values: [true, false] |
message |
string Message |
Message that summarizes the results of the request. |
timestamp |
string(date-time) Timestamp |
UTC timestamp of the response. |
item |
pavliks.PortalConnector.PowerPlatform.Models.Engine.Operations.Sitefinity.User.UserInfo User: |
Object that is used to hold user and profile information. |
Summary:
Description: Portal User Response Message.
Properties:
Name |
Type |
Summary |
status |
boolean Status |
Boolean that indicates whether the request failed (false) or succeeded (true). Values: [true, false] |
message |
string Message |
Message that summarizes the results of the request. |
timestamp |
string(date-time) Timestamp |
UTC timestamp of the response. |
item |
pavliks.PortalConnector.PowerPlatform.Models.Engine.Operations.TPC.PortalUser.PortalUserInfo User: |
Object that is used to hold portal user and profile information. |
Summary:
Description: Portal Users Response Message.
Properties:
Name |
Type |
Summary |
status |
boolean Status |
Boolean that indicates whether the request failed (false) or succeeded (true). Values: [true, false] |
message |
string Message |
Message that summarizes the results of the request. |
timestamp |
string(date-time) Timestamp |
UTC timestamp of the response. |
count |
integer(int32) Portal Users Count |
Total number of portal users. |
items |
array of (pavliks.PortalConnector.PowerPlatform.Models.Engine.Operations.TPC.PortalUser.PortalUserInfo) Portal Users |
List of portal users. |
Summary:
Description: Object that is used to help select a portal user item. In future iterations this object may also be used to add filtering criteria.
Properties:
Name |
Type |
Summary |
id |
string(uuid) Id |
Gets or sets the identifier of the user. |
Summary:
Description: Generic Portal Response Message.
Properties:
Name |
Type |
Summary |
status |
boolean Status |
Boolean that indicates whether the request failed (false) or succeeded (true). Values: [true, false] |
message |
string Message |
Message that summarizes the results of the request. |
timestamp |
string(date-time) Timestamp |
UTC timestamp of the response. |
Summary:
Description: Request Object that is Used to Subscribe to a Portal Web Hook
Properties:
Name |
Type |
Summary |
callBackUrl |
string Call Back URL |
Callback url of the web hook request. |
Summary:
Description: Request object that is used to subscribe for a Login on a Portal site
Properties:
Name |
Type |
Summary |
callBackUrl |
string Call Back URL |
Callback url of the web hook request. |
userId |
string(uuid) User Id |
User Id - leave empty to trigger on all user logins. |
loginResult |
integer Login Result |
Login Result - Leave empty to trigger on all login results. Values: [, , , , , , , , , , , , , , ] |
Summary:
Description: Request object that is used to subscribe for a logout on a portal site.
Properties:
Name |
Type |
Summary |
callBackUrl |
string Call Back URL |
Callback url of the web hook request. |
userId |
string(uuid) User Id |
User id - leave empty to trigger on all user logins. |
Summary:
Description: Request object that is used to subscribe for a comment event on a portal site
Properties:
Name |
Type |
Summary |
contentType |
string Content Type |
Content type - leave empty to trigger on all content types. |
contentId |
string(uuid) Content Id |
Content id - leave empty to trigger on all content. |
callBackUrl |
string Call Back URL |
Callback url of the web hook request. |
Summary:
Description: Request object that is used to subscribe for a Content event on a portal site
Properties:
Name |
Type |
Summary |
contentType |
string Content Type |
Content Type - Leave empty to trigger on all content types. |
callBackUrl |
string Call Back URL |
Callback url of the web hook request. |
Summary:
Description: Request object that is used to subscribe for a Form Entry on a Portal site
Properties:
Name |
Type |
Summary |
formId |
string(uuid) Form Id |
Form id - leave empty to trigger on all form submissions. |
callBackUrl |
string Call Back URL |
Callback url of the web hook request. |
Summary:
Description: Request object that is used to subscribe for a Page Navigation on a Portal site
Properties:
Name |
Type |
Summary |
pageId |
string(uuid) Page Id |
Page id - leave empty to trigger on all page navigation events. |
callBackUrl |
string Call Back URL |
Callback url of the web hook request. |
Summary:
Description: Request object that is used to subscribe for a role action on a portal site.
Properties:
Name |
Type |
Summary |
roleId |
string(uuid) Role Id |
Role id - leave empty to trigger on all role events. |
userId |
string(uuid) User Id |
User id - leave empty to trigger on all role events regardless of user. |
callBackUrl |
string Call Back URL |
Callback url of the web hook request. |
Summary:
Description: Request object that is used to subscribe for a Sitefinity search on a portal site.
Properties:
Name |
Type |
Summary |
criteria |
string Search Criteria |
Search criteria - leave empty to trigger on all searches. |
callBackUrl |
string Call Back URL |
Callback url of the web hook request. |
Summary:
Description: Request object that is used to subscribe for a form submission on a portal site.
Properties:
Name |
Type |
Summary |
formId |
string(uuid) Form Id |
Form id - Leave empty to trigger on all form submissions. |
callBackUrl |
string Call Back URL |
Callback url of the web hook request. |
Summary:
Description: Request object that is used to subscribe for a TPC knowledge search on a portal site.
Properties:
Name |
Type |
Summary |
criteria |
string Search Criteria |
Search criteria - leave empty to trigger on all searches. |
callBackUrl |
string Call Back URL |
Callback url of the web hook request. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |