Home >

Purpose TOC   |    Annotated TOC   |

AssetGetSiteNode

Returns the node ID of the specified page asset.

Syntax

assetGetSiteNode(java.lang.String authusername, 
                 java.lang.String authpassword, 
                 java.lang.String TYPE, 
                 java.lang.String OBJECTID, 
                 java.lang.String FIELD, 
                 java.lang.String VALUE, 
                 java.lang.String EXCLUDE, 
                 java.lang.String FIELDLIST) 

Parameters

authusername (required)

(String) Name of the user to log in, as registered in Sites .

authpassword(required)

(String) Password for the associated user name.

TYPE (required)

(String) The asset type of the asset that you want to retrieve from the database. For your web service, the value must be page.

Typically, you provide TYPE and OBJECTID. When you know that a specific field/value pair can uniquely identify the asset, however, you can provide TYPE and the field/value pair instead. Either the OBJECTID or the FIELD and VALUE combination, but not both, are required to load an asset.

OBJECTID (required)

(String) The unique identifying number that references the Asset object. Not required if you use TYPE with the FIELD and VALUE paired parameters.

FIELD (optional)

(String) A field is any one of the column names for the asset. For example, standard fields for Sites assets include name, template, status, description, subtype, category, modified, headline, byline, and body. Use the field name in conjunction with the VALUE parameter as the name portion of a name/value pair. The field name and its corresponding value uniquely identifies the asset to be loaded. Note that if the field/value pair that you supply identifies more than one asset, the AssetLoad operation uses the first one that it finds.

Not required if you use TYPE with the OBJECTID parameter.

VALUE (optional)

(String) Value that corresponds to the field specified by the FIELD parameter. Paired with the field name, this parameter uniquely identifies an asset by supplying the associated value.

Not required if you use TYPE with the OBJECTID parameter.

EXCLUDE (optional)

(Boolean) Depending on whether the value of EXCLUDE is True or False, this operation either returns the fields specified in the FIELDLIST parameter or returns the fields not contained in the list.

True indicates that all fields except the fields in the FIELDLIST are to be returned.

False indicates that only fields in FIELDLIST are to be returned. That is, it returns fields specified with the FIELDLIST parameter. The default value is False.

FIELDLIST (optional)

(String) Comma-separated list of fields that you want to include or exclude from the request for asset fields. The EXCLUDE parameter, which operates on the field list, determines whether the fields in the list are returned or whether all fields other than those in the list are returned.

Description

The relationships set up between page assets on the site tree in the Sites main window are stored in the SitePlanTree table. The AssetGetSiteNode operation uses the object ID of a page asset to retrieve its node ID from that table.

With the node ID, you can acquire information about the site's hierarchy to use for display. For example, you can create a navigation bar with links to section pages or a link back to the parent page.

Returns

String containing the site node ID.

Error Numbers

The possible values of errno include:

Value	Description
-10001	The implementing class is invalid.
-10002	There is a missing method for the implementing class.
-10003	The method could not be invoked successfully.
-10004	A required parameter is missing.
-10005	The requested object is not in the object pool (is not loaded into memory).
-10006	The object ID is not valid.
-10007	The version of the object is not valid.
-10009	More than one object met the specified criteria.

 

Example

This code loads a page asset and then determines the site node of that page:

AssetService service = new AssetServiceLocator();
AssetPortType port = service.getAssetPort();
String retVal = port.assetGetSiteNode("user_author", "demo", "Page", "968685128066", null, null, null, null);

 

		Home >	Contents >	Index >
	Oracle Web Services Reference Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.