Documentation Center

ObjectLocationList XML Structure

The ObjectLocationList XML structure is used to hold a list of logical objects and their folder paths.

XML structure

<xs:schema id="ISHObjects-FolderLocation" 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:sequence minOccurs="1" maxOccurs="1">
				<xs:element ref="ishfolderpath" minOccurs="1" maxOccurs="1"/>
			</xs:sequence>
			<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="required">
				<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="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:complexType>
	</xs:element>
	<xs:element name="ishfolderpath">
		<xs:complexType>
			<xs:sequence minOccurs="0" maxOccurs="unbounded">
				<xs:element ref="ishfolderpathsegment"/>
			</xs:sequence>
			<xs:attribute name="basefolder" use="required">
				<xs:simpleType>
					<xs:restriction base="xs:string">
						<xs:enumeration value="Data"/>
						<xs:enumeration value="System"/>
						<xs:enumeration value="Favorites"/>
					</xs:restriction>
				</xs:simpleType>
			</xs:attribute>
		</xs:complexType>
	</xs:element>
	<xs:element name="ishfolderpathsegment">
		<xs:complexType>
			<xs:simpleContent>
				<xs:extension base="xs:string">
					<xs:attribute name="depth" use="required">
						<xs:simpleType>
							<xs:restriction base="xs:long">
								<xs:minInclusive value="1"/>
							</xs:restriction>
						</xs:simpleType>
					</xs:attribute>
					<xs:attribute name="ishfolderref" use="required">
						<xs:simpleType>
							<xs:restriction base="xs:long">
								<xs:minInclusive value="0"/>
								<xs:maxInclusive value="9999999999"/>
							</xs:restriction>
						</xs:simpleType>
					</xs:attribute>
				</xs:extension>
			</xs:simpleContent>
		</xs:complexType>
	</xs:element>
</xs:schema>
More information:
  • Logical objects that do not exist in the database are not returned in the XML

Example

<ishobjects>
	<ishobject ishref="GUID-AF99C63E-7887-4485-A7ED-ACED50781F70" ishtype="ISHLibrary" ishlogicalref="16333">
		<ishfolderpath basefolder="Data">
			<ishfolderpathsegment depth="1" ishfolderref="12006">Topics</ishfolderpathsegment>
			<ishfolderpathsegment depth="2" ishfolderref="11872">ProjectOne</ishfolderpathsegment>
			<ishfolderpathsegment depth="3" ishfolderref="6334">Libraries</ishfolderpathsegment>
		</ishfolderpath>
	</ishobject>
	<ishobject ishref="GUID-6261FFD4-ED5D-407E-A0B9-B300B463295B" ishtype="ISHModule" ishlogicalref="14177">
		<ishfolderpath basefolder="Data">
			<ishfolderpathsegment depth="1" ishfolderref="12006">Topics</ishfolderpathsegment>
			<ishfolderpathsegment depth="2" ishfolderref="11872">ProjectOne</ishfolderpathsegment>
			<ishfolderpathsegment depth="3" ishfolderref="9476">Configuration</ishfolderpathsegment>
			<ishfolderpathsegment depth="4" ishfolderref="12968">Import</ishfolderpathsegment>
		</ishfolderpath>
	</ishobject>
	<ishobject ishref="ISHCONDITIONMANAGEMENT" ishtype="ISHTemplate" ishlogicalref="5971">
		<ishfolderpath basefolder="System">
			<ishfolderpathsegment depth="1" ishfolderref="5977">Conditions</ishfolderpathsegment>
		</ishfolderpath>
	</ishobject>
	<ishobject ishref="EDITORTEMPLATE-GENERALTASK" ishtype="ISHModule" ishlogicalref="49739">
		<ishfolderpath basefolder="System">
			<ishfolderpathsegment depth="1" ishfolderref="10097">Editor template</ishfolderpathsegment>
			<ishfolderpathsegment depth="2" ishfolderref="49694">DITA 1.2 Topics</ishfolderpathsegment>
		</ishfolderpath>
	</ishobject>
	<ishobject ishref="GUID-948DDC21-5669-4BE6-B1E3-E41739B4EE51" ishtype="ISHIllustration" ishlogicalref="14036">
		<ishfolderpath basefolder="Data">
			<ishfolderpathsegment depth="1" ishfolderref="7433">Graphics</ishfolderpathsegment>
			<ishfolderpathsegment depth="2" ishfolderref="14020">Logos</ishfolderpathsegment>
		</ishfolderpath>
	</ishobject>
</ishobjects>

The breadcrum of the first "ishobject" in this example would show "General : Topics : ProjectOne : Libraries" in the website