SS_GET_SITE_AS_XML_EX2 SS_GET_SITE_ASSET_CATEGORIES SS_GET_SITE_CHANGE_MONITOR_TOKEN

Site Studio Services 11-23

11.7.43 SS_GET_SEARCH_RESULTS

■ Description : This service is a wrapper around the regular GET_SEARCH_ RESULTS service. It allows some Site Studio features to be specified simply as flags and have the real query syntax be constructed on the server. It can modify the standard SearchResults result set to contain an additional column called ssUrl which will contain the Site Studio-friendly url for all of the search results. ■ Parameters: – siteId : the unique identifier of the site required. – ssLimitScope : this restricting scope to within the site only optional. It is true, false, or -1. True alters the QueryText with a clause for xWebsites. False does not alter the QueryText for xWebsites. -1 alters the QueryText with a not clause for xWebsites. – ssUserSearchText : a user-supplied search text optional. This is joined to the supplied QueryText. – ssWebsiteObjectType : the object type optional. This appends to the QueryText the requirement that xWebsiteObjectType match the specified object type. – computeFriendlyUrls : this modifies results to include ssUrl optional. This parameter defaults to true. – ssDontShowInLists : this is used to limit the search to those documents where the siteId is contained in the xDontShowInListsForWebsites metadata field. This parameter is truefalse. These parameters are all in addition to those required by GET_SEARCH_ RESULTS. ■ Returns : – A result set named Search Results. ■ Security : The user must have read access to at least one security group on the content server.

11.7.44 SS_GET_SITE_AS_XML_EX2

■ Description : This service retrieves the entire site with nodes and attributes as XML. ■ Parameters: – siteId : the unique identifier of the site required. – includeProperties : A Boolean parameter true or false that indicates whether the properties of the nodes should be included as result sets in the response optional. ■ Returns: – siteXml : an XML representation of the site. – Optionally returns two result sets, StandardProperties and SiteStudioProperties, which give the properties of the nodes in the XML file. A nodeId parameter associates rows in the result set to the nodes of the XML. 11-24 Oracle Fusion Middleware Technical Reference Guide for Site Studio ■ Security : This requires that the user have at least write access to the root node of the hierarchy. The returned XML will enumerate every node in the hierarchy. This is because Site Studio has to be able to show a tree structure that the user can navigate through to get to nodes that he can modify.

11.7.45 SS_GET_SITE_ASSET_CATEGORIES

■ Description : This service retrieves the site asset categories for a site from the project file. ■ Parameters: – siteId : the unique identifier of the site required. ■ Returns: – A result set named SiteAssetCategories containing the following columns: name, type, querytext, metadata, and description. ■ Security : The user must have write access to at least one security group on the content server.

11.7.46 SS_GET_SITE_CHANGE_MONITOR_TOKEN

■ Description : This is a heartbeat service that Designer normally runs every 10 seconds by default to determine if changes have been made to the site by someone else. ■ Parameters: – siteId : the unique identifier of the site required. ■ Returns: – ssChangeMonitorToken : an identifier that changes when the web site changes. ■ Security: ■ The user must have at least read access to the project root element. ■ This service can be executed from Idoc script.

11.7.47 SS_GET_SITE_DEFINITION