ObjectList
The contents of an inbox, a folder in the repository, a call by a retrieve function or a query result consists of multiple Content Manager objects. These objects are presented in an XML object list structure.
XML structure
<?xml version="1.0" encoding="utf-8" ?>
<xs:schema id="ISHObjects" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="ishobjects">
<xs:complexType>
<xs:sequence minOccurs="0" maxOccurs="unbounded">
<xs:element ref="ishobject"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="ishobject">
<xs:complexType>
<xs:choice maxOccurs="unbounded">
<xs:element ref="ishfields" minOccurs="0" maxOccurs="1" />
<xs:element ref="ishdata" minOccurs="0" maxOccurs="1" />
</xs:choice>
<xs:attribute name="ishref" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="255"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="ishlogicalref" use="optional">
<xs:simpleType>
<xs:restriction base="xs:long">
<xs:minInclusive value="0"/>
<xs:maxInclusive value="9999999999"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="ishversionref" use="optional">
<xs:simpleType>
<xs:restriction base="xs:long">
<xs:minInclusive value="0"/>
<xs:maxInclusive value="9999999999"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="ishlngref" use="optional">
<xs:simpleType>
<xs:restriction base="xs:long">
<xs:minInclusive value="0"/>
<xs:maxInclusive value="9999999999"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="ishtype" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="ISHNone" />
<xs:enumeration value="ISHNotFound" />
<xs:enumeration value="ISHModule" />
<xs:enumeration value="ISHMasterDoc" />
<xs:enumeration value="ISHLibrary" />
<xs:enumeration value="ISHTemplate" />
<xs:enumeration value="ISHIllustration" />
<xs:enumeration value="ISHReusedObj" />
<xs:enumeration value="ISHPublication" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="revisionid" use="optional">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="255"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="ishfields">
<xs:complexType>
<xs:sequence minOccurs="0" maxOccurs="unbounded">
<xs:element ref="ishfield"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="ishfield">
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="name" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="255"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="level" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="none"/>
<xs:enumeration value="logical"/>
<xs:enumeration value="version"/>
<xs:enumeration value="lng"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="ishvaluetype" use="optional">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value=""/>
<xs:enumeration value="value"/>
<xs:enumeration value="element"/>
<xs:enumeration value="id"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:element name ="ishdata">
<xs:complexType>
<xs:simpleContent>
<xs:extension base="CDATA">
<xs:attribute name="edt" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="255"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="mimetype" use="required" type ="xs:string"/>
<xs:attribute name="fileextension" use="required" type ="xs:string"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:simpleType name ="CDATA">
<xs:restriction base="xs:string">
<xs:whiteSpace value ="replace"/>
</xs:restriction>
</xs:simpleType>
</xs:schema>
- More information
-
- The
ishtypecan contain theISHNotfoundvalue when a given or referenced DocId cannot be found in the database. - The
ishversionrefandishlngrefattributes of theishobjectelement contain reference numbers to the version and language parts of an object and are intended for internal use. - The
ishdatasection is base64 encoded.
- The
- Note
-
- The
DOC-LANGUAGEcan be multi lingual. - In
Web Services 2.5you can request different value types for the same field (e.g. label and element name) . The values for each field are sorted on value sequences. So, if you are requesting information about a field that is linked with a list of values, you can map the label to the element name.
- The
Example
<ishobjects>
<ishobject ishref="INTRO" ishtype="ISHModule" ishversionref="8134" ishlngref="8149">
<ishfields>
<ishfield name="FTITLE" level="logical">Introduction</ishfield>
<ishfield name="VERSION" level="version">3</ishfield>
<ishfield name="FAUTHOR" level="lng">Van Calster</ishfield>
<ishfield name="FSTATUS" level="lng" valuetype="value">Under construction</ishfield>
<ishfield name="FSTATUS" level="lng" valuetype="element">VSTATUSUNDERCONSTRUCTION</ishfield>
<ishfield name="DOC-LANGUAGE" level="lng">en</ishfield>
</ishfields>
<ishdata edt="EDTXML" mimetype="text/xml" fileextension="xml">
<![CDATA[
PFhNTEZJTEU+UHJvamVjdE1hbmFnZW1lbnQ/PC9YTUxGSUxFPg0K
]]>
</ishdata>
</ishobject>
<ishobject ishref="GUID.35872B4E.5924.4BE1.86B5.74CADD33FD39" ishtype="ISHIllustration" ishversionref="123456" ishlngref="123457">
<ishfields>
<ishfield name="FTITLE" level="logical">Conditional publishing</ishfield>
<ishfield name="VERSION" level="version">1</ishfield>
<ishfield name="FAUTHOR" level="lng">Frank Closset</ishfield>
<ishfield name="FSTATUS" level="lng" valuetype="value">Released</ishfield>
<ishfield name="FSTATUS" level="lng" valuetype="element">VSTATUSRELEASED</ishfield>
<ishfield name="FRESOLUTION" level="lng">Low</ishfield>
<ishfield name="DOC-LANGUAGE" level="lng">en, fr, nl, de</ishfield>
</ishfields>
<ishdata edt="EDTJPG" mimetype="image/jpeg" fileextension="jpg">
<![CDATA[...]]>
</ishdata>
</ishobject>
</ishobjects>