GetObjects Operation

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).

Request

An array of ObjectRequestType elements, each of which specifies the following:

  • An object reference specifying an object or object set collection to retrieve.
  • A property filter, which specifies which properties will be returned in the retrieved object. It can specify one or more of the following:
    • An array of identified properties to include.
    • An array of data types, all properties of which will be included.
    • A list of properties to exclude, overriding any properties previously specified.
    • One or more attributes to control how the property filter is applied in special cases.
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 PropertyFilter
          FilterElementType IncludeProperties[0]
          FilterElementType IncludeProperties[1]
               .
               .
          FilterElementType IncludeTypes[0]
          FilterElementType IncludeTypes[1]
               .
               .
     ObjectReference(ObjectSpecification) SourceSpecification
ObjectRequestType GetObjectsRequest[1]
               .
               .

Response

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:
    • A class ID, object ID, and object store identifying the object.
    • An array of identified properties and their values.
  • ObjectSetResponse Returns an object set collection of objects. This element specifies the following:
    • An collection terminator indicating the state of navigation within the object set.
    • An array of ObjectValue elements.
  • ErrorStackResponse: Returns an error that has occurred while retrieving an object. This element specifies the following:
    • The error name.
    • A description of the error.
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 ObjectSet
          CollectionTerminatorType CollectionTerminator
          ObjectValue Object[0]
               (SingletonString)PropertyType Property[0]
               (SingletonInteger32)PropertyType Property[1]
                    .
                    .
          ObjectValueObject[1]
               (SingletonString)PropertyType Property[0]
               (SingletonInteger32)PropertyType Property[1]
                    .
                    .
ObjectResponseType ObjectResponseTypeArray[2]
          .
          .
:

XML Schema

<operation name="GetObjects">
   <input message="tns:GetObjectsRequest"/>
   <output message="tns:GetObjectsResponse"/>
   <fault message="tns:FaultResponse" name="GeneralError"/>
</operation>