SS_GET_REGION_ASSOCIATIONS SS_GET_REGION_DEFINITION_ELEMENTS SS_GET_RELATIVE_NODE_ID SS_GET_SEARCH_RESULTS

11-22 Oracle Fusion Middleware Technical Reference Guide for Site Studio

11.7.40 SS_GET_REGION_ASSOCIATIONS

■ Description : This service returns region associations of primary and secondary URLs that have been changed via the SS_SWITCH_REGION_ASSOCIATION service URLs. ■ Parameters: – siteId : the unique identifier of the site required. ■ Returns : – Primary : all primary URLs for the site. – Secondary : all secondary URLs for the site. ■ Security : The user must have write access to at least one security group on the content server.

11.7.41 SS_GET_REGION_DEFINITION_ELEMENTS

■ Description : This service retrieves all element definitions listed in a region definition. ■ Parameters: – regionDefinition: the unique identifier of the region definition. ■ Returns: – A result set named ssElementConfigs containing the following columns: SSElementType, SSElementTitle, SSElementName, SSElementIsList, SSSubelements. ■ Security : The user must have write access to at least one security group on the content server.

11.7.42 SS_GET_RELATIVE_NODE_ID

■ Description : This service retrieves the node identifier of the given relative; useful for enumerating the site hierarchy. ■ Parameters: – siteId : the unique identifier of the site required. – nodeId : the identifier of the node required. – relative : one of the following: parent, child, next, or prior required. ■ Returns: – relativeId : the identifier of the relative node in the site hierarchy. If there is no such relative, the empty string is returned. ■ Security: ■ The user must have at least read access to the specified node. ■ This service can be executed from Idoc script. 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