Show TOC

Background documentationOBNWsResult Locate this document in the navigation structure

 

Contains the output for most of the requests of the OBN Web service. Each OBNWsResult object can represent a business object, operation, or operation implementation.

For example, if a request returns a list of operation implementations for a specific operation for the current user, each OBNWsResult object represents one operation implementation. On the other hand, if a request returns a list of operations that have any operation implementation for the current user, each OBNWsResult object represents one operation.

Fields

Name

Type

Description

systemAlias

String

The system alias of the business object specified by objectName.

Specified only for system business objects.

namespace

String

The object ID prefix of the business object specified by objectName.

Specified only for context business objects.

objectName

String

The ID of a business object.

operationName

String

The ID of an operation of the business object.

opFriendName

String

The display name for the operation specified by operationName.

obnUrl

String

An OBN URL, if the result represents an operation implementation.

contexts

String[]

An array of PCD locations of folders and roles in which this result was found.

The following is an example context:

pcd://portal_content/myFolder

params

OBNWsParam[]

The parameters used by Navigation by Attribute.

errorMessage

String

An error message, for use when a mass request was performed.

If the entire mass request fails, an exception is thrown. However, if some of the OBNMetadata request parameters can be resolved, OBNResult response objects are returned for all the request objects, and an error message is returned for those parameters that could not be resolved.