Home >	Contents >	Index >

Expanded TOC   |    Purpose TOC   |    Annotated TOC   |    Index

AssetList

Returns a list of assets for a specific asset type. The list is filtered according to specified criteria.

Syntax

assetList(java.lang.String authusername, 
          java.lang.String authpassword, 
          java.lang.String TYPE, 
          java.lang.String FIELD1, 
          java.lang.String FIELD2, 
          java.lang.String FIELD3, 
          java.lang.String FIELD4, 
          java.lang.String FIELD5, 
          java.lang.String FIELD6, 
          java.lang.String FIELD7, 
          java.lang.String FIELD8, 
          java.lang.String FIELD9, 
          java.lang.String VALUE1, 
          java.lang.String VALUE2, 
          java.lang.String VALUE3, 
          java.lang.String VALUE4, 
          java.lang.String VALUE5, 
          java.lang.String VALUE6, 
          java.lang.String VALUE7, 
          java.lang.String VALUE8, 
          java.lang.String VALUE9, 
          java.lang.String ORDER, 
          java.lang.String SITEID, 
          java.lang.String EXCLUDEVOIDED) 

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.

FIELD (1-9) (optional)

Input. The name of a field to use to restrict the list. You can specify up to nine fields. If you specify a field name, you must also pass in a corresponding VALUE for the field. For example: FIELD1="Category" VALUE1= "Sports".

VALUE (1-9) (optional)

Input. Required if FIELD is specified. The field value to use to restrict the list. You can specify up to nine FIELD/VALUE pairs. For example, VALUE1, VALUE2, and so on.

ORDER (optional)

(String) Name of the asset column (field) used to sort the results, specified as a string.

Input. The fields to sort the list by, and whether the sort result on those fields is ascending or descending. By default, the sort is ascending. If you specify more than one field, separate the field names with a comma.

For example, if you specify ORDER="nrank", the list is sorted by rank starting at number 1. If you want the list sorted by descending rank, use ORDER="nrank desc".

SITEID (optional)

ID of the site (formerly publication) to which the query is restricted. When this optional parameter is used, the query is a database join operation against the AssetPublication table.

EXCLUDEVOIDED (optional)

The specified value determines whether previously deleted (voided) assets are returned:

True returns assets that have not been deleted and that meet the specified criteria. The default value is True.

False returns deleted and undeleted assets that meet the specified criteria.

Description

The returned list that contains rows that exactly match the specified name/value pairs for the supplied asset type. A FIELD and VALUE pair comprise the name of the field and its value. Because you are trying to match the value, you must know it beforehand. If no name/value pairs are specified, all rows and their associated values are returned. In addition, all columns in the AssetTypes main table are returned.

Inputs

Accepts specified name/value pairs as input.

Returns

Rows from the asset main table that include values that match the specified columns.

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.

 

Example

AssetService service = new AssetServiceLocator();
AssetPortType port = service.getAssetPort();
IList myList = port.assetList("user_author", "demo", "Products", "status", null, null, null, null, null, null, null, null, "PL", null, null, null, null, null, null, null, null, null, null, null);

 

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