Element Structure
- Attributes
String batchRef: [request] Optional expression
specifying an identifying string for an object-valued property of
single cardinality in the set of ActionProperties specified
in a ChangeRequestType element. This must match the ChangeRequestType element's
correlating id attribute. If batchRef is
present, all other attributes must be omitted.Int32 itemIndex: [request] Optional expression
specifying an element in a multi-valued property collection. If you
use propertyId to specify a multi-valued object-valued
property, you must use this attribute to indicate the (zero-based)
ordinal of the specified object in the object collection. A value
of -1 returns all objects in the collection.String path: [request] Optional expression
specifying, for containable objects only, a path to the object as
an alternative to an objectId value. For example,
"/BlueFolder/Demo.doc".String propertyId: [request] Optional
expression identifying an object-valued property of the object specified
by the classId, objectId (or path),
and objectStore attributes. If this attribute is
provided, it acts as an additional qualifier that allows you to instead
specify an object or objects referenced by the object's object-valued
property. This attribute can specify either a symbolic name or a GUID.
- Attributes Specific to .NET Clients
Boolean itemIndexSpecified: Optional expression
specifying whether itemIndex has a value (true)
or not (false).
Base Element Inheritance
- Attributes
String classId: [request] Required expression
identifying the class of the object. This attribute can specify either
a symbolic name or a GUID.String objectId: [request] Required (except
for EntireNetwork objects and query result rows)
expression specifying the GUID of an object. Exceptions apply for
the following types of objects:
Realm: The name of the realm must be specified.Group or User: The principal
name of the group or user must be specified.ClassDescription: The symbolic name of an object's
class can be specified instead of an object's GUID.
String objectStore: [request] Required
(optional for objects that are not stored in the database repository)
expression identifying the object store to which a specified object
belongs. This attribute can specify a symbolic name, display name,
or GUID.
XML Schema
<xsd:complexType name="ObjectSpecification">
<xsd:annotation>
<xsd:documentation xml:lang="en">An ObjectSpecification can be used in a request anywhere
that calls for an ObjectReference</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="ObjectReference">
<xsd:attribute name="path" type="xsd:string"/>
<xsd:attribute name="propertyId" type="xsd:string"/>
<xsd:attribute name="itemIndex" type="xsd:int"/>
<xsd:attribute name="batchRef" type="xsd:IDREF"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>