Services Integration Framework Guide

10.4 HotFix 3
- 10.5
- 10.4 HotFix 2
- 10.4 HotFix 1
- 10.4
- 10.3 HotFix 3
- 10.3 HotFix 2
- 10.3 HotFix 1
- 10.3

Back Next

ListSiperianObjects

returns basic metadata for a list of MDM Hub objects of the specified type. The metadata contains basic information such as SiperianObjectUID, display name, and description. To get an object's complete metadata, use DescribeSiperianObject.

Restrictions

Only admin users can access private resources through SIF API requests.

Required Parameters

The

ListSiperianObjects

request does not have required parameters.

Optional Parameters

Use the optional parameters to filter the list of objects returned by

ListSiperianObjects

. The following table describes the optional parameters.

Parameter	Description
ParentUID	Restricts the returned list to objects that are children of the parent specified by ParentUID.
ObjectType	Restricts the returned list to objects of the type specified by ObjectType.
UserResourcesOnly	When UserResourcesOnly is true , restricts the returned list to those objects for which the user has security resource privileges enabled. When UserResourcesOnly is false , the returned list is not restricted by security resource privileges.
PrivilegeType	Restricts the returned list to objects with a specific secure resource privilege enabled for the user. Possible values are CREATE , DELETE , DESIGN , EXECUTE , MERGE , NONE , READ , UPDATE , WRITE .

Response Fields

The following table describes the response fields:

Parameter	Description
Uid	Contains the SiperianObjectUID.
Name	Contains the object name.
DisplayName	Contains the display name.
Description	Contains the object description.

Use Case

The following scenario is a common use for the

ListSiperianObjects

request:

For a particular base object, get a list of packages. If you have a custom UI, you can use this request to get a list of packages for a base object so the user can select a base object for the current operation.

ListSiperianObjects Request Usage Examples

The following example shows how to request the metadata of the columns for the base object "C_PARTY":

ListSiperianObjectsRequest request = new ListSiperianObjectsRequest();
request.setObjectType(SiperianObjectType.COLUMN);
request.setParentUid(SiperianObjectType.PACKAGE.makeUid("C_PARTY"));
request.setUserResourcesOnly(false); //ignores security access configuration of object
ListSiperianObjectsResponse response = (ListSiperianObjectsResponse) sipClient.process(request);

When retrieving a list of users, you can set the parentUID to a Role UID to restrict the list to users that belong to a specific role. To retrieve a list of admin users, the role can be set to

ROLE.REQUEST_ADMIN_USERS_ONLY

using

request.setParentUid(SiperianObjectType.ROLE.makeUid("REQUEST_ADMIN_USERS_ONLY"))

. The following example shows how to request the metadata of users that belong to the role of

Manager

ListSiperianObjectsRequest request = new ListSiperianObjectsRequest();
request.setObjectType(SiperianObjectType.USER);
request.setParentUid(SiperianObjectType.ROLE.makeUid("Manager"));
request.setUserResourcesOnly(false); //ignores security access configuration of object
ListSiperianObjectsResponse response = (ListSiperianObjectsResponse) sipClient.process(request);

ListSiperianObjects Response Usage Example

The following example shows how to print out the object metadata returned by the

ListSiperianObjects

response:

ListSiperianObjectsResponse response = new ListSiperianObjectsResponse();
int i=0;
for(Iterator iter=response.getMetaDataObjectList().iterator(); iter.hasNext();) { //iterate through metadata objects
  System.out.println("Printing metadata object " + i);
  MetaDataBase metadata = (MetaDataBase) iter.next();
  System.out.println("/tuid="+metadata.getUid());
  System.out.println("/tname="+metadata.getName());
  System.out.println("/tdisplay name="+metadata.getDisplayName());
  System.out.println("/tdescription="+metadata.getDescription());
}