Bookshelf Home | Contents | Index | PDF     

Siebel Analytics Web Administration Guide > Working with Data and Managing the Web Catalog Using Siebel Analytics Web SOAP API > Description of Structures in the Siebel Analytics Web SOAP API >

GetSubItemsParams Structure

The GetSubItemsParams structure contains optional parameters used in a getSubItems call. This structure is used in the WebCatalogService service. Table 24 lists the fields in this structure.

Table 24. GetSubItemsParams Structure Fields
Fields
Descriptions

filter

Used for internal purposes only. This should be null.

includeACL

If true, ACL information is included in the resulting ItemInfo structures.

withPermission

Filter the resulting items collection by access level. The only items included in the result are those for which the following expression is true:

(itemPermission & withPermissionMask) = (withPermission & withPermissionMask)

Where itemPermission is a combination of permission flags for current catalog item.

withPermissionMask

withAttributes

Filter the resulting items collection by attribute flags. The only items included in the result are those for which the following expression is true:

(itemAttributes & withAttributesMask) = (withAttributes & withAttributesMask)

Where itemAttributes is a combination of attribute flags for current catalog item.

withAttributesMask
    
Siebel Analytics Web Administration Guide