Client Declaration
public ObjectResponseType[] GetObjects(ObjectRequestType[] GetObjectsRequest)
Retrieves one or more Content Engine objects.
There is no restriction on the combination of objects that can be retrieved
in a single call. A GetObjects
call will return successfully even if none
of the requested objects can be loaded. A failure will be reported as a SOAP
fault response only as a result of an exceptional condition in the server
(for example, an out-of-memory error).
An array of ObjectRequestType
elements, each of which specifies the following:
A typical structure of a GetObjects
request is as follows. Elements that are derived from their base element are in parenthesis:
ObjectRequestType
GetObjectsRequest[0]PropertyFilterType
PropertyFilterFilterElementType
IncludeProperties[0]FilterElementType
IncludeProperties[1] . .FilterElementType
IncludeTypes[0]FilterElementType
IncludeTypes[1] . .ObjectReference
(ObjectSpecification
) SourceSpecificationObjectRequestType
GetObjectsRequest[1] . .
An array of concrete subtypes of the abstract ObjectResponseType
element, each of which matches a corresponding ObjectRequestType
element used in the GetObjects
input array. Depending on the type of object returned, one of the following ObjectsResponseType
subtypes is returned for each item in the array:
SingleObjectResponse
: Returns a single object. This element specifies the following:
ObjectSetResponse
Returns an object set collection of objects. This element specifies the following:
ObjectValue
elements. ErrorStackResponse
: Returns an error that has occurred while retrieving an object. This element specifies the following:
A typical structure of a GetObjects
response is as follows. Elements that are derived from their base element are in parenthesis:
(SingleObjectResponse
)ObjectResponseType
ObjectResponseTypeArray[0]ObjectValue
Value (SingletonString
)PropertyType
Property[0] (SingletonInteger32
)PropertyType
Property[1] . . (ObjectSetResponse
)ObjectResponseType
ObjectResponseTypeArray[1] (EndofPage
)ObjectSetType
ObjectSetCollectionTerminatorType
CollectionTerminatorObjectValue
Object[0] (SingletonString
)PropertyType
Property[0] (SingletonInteger32
)PropertyType
Property[1] . .ObjectValue
Object[1] (SingletonString
)PropertyType
Property[0] (SingletonInteger32
)PropertyType
Property[1] . .ObjectResponseType
ObjectResponseTypeArray[2] . .
<operation name="GetObjects"> <input message="tns:GetObjectsRequest"/> <output message="tns:GetObjectsResponse"/> <fault message="tns:FaultResponse" name="GeneralError"/> </operation>