Product Documentation articleRetrieve a document type: lq851
Added by IBM contributorXiang Yu Hao | Edited by IBM contributorCraig Lordan on October 21, 2011 | Version 9
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

No abstract provided.

Retrieve a document type

This is the specification for applications that retrieve Document Type resources.

URL endpoints

Perform a GET operation on one of the following URL formats:

URL
Description
/library/{library-id}/documenttypes/{documenttype-id}/entry
Retrieve a document type given its id.



Authentication

This method requires authentication

Arguments


The following URL arguments are supported on this operation. The default value for any argument is marked as bold in the table below:

Argument
Example
Description
includePropertySheetTypesboolean (true, false)Indicates that for each property sheet type referenced by this document type, the entry describing the property sheet type will be embedded in the element instead of its id.



Error Codes
Error Code
Description
Unknown
Returned when the cause of an error is unknown
AccessDenied
Returned when the cause of an error is due to a permission restriction
ItemNotFound
Returned when the cause of an error is related to a resource not being found
Unsupported Operation
Returned when the operation is not supported



Example Request





Example Response




<entry xml:base="http://hao.cn.ibm.com/" xmlns="http://www.w3.org/2005/Atom" xmlns:td="urn:ibm.com/td" xmlns:snx="http://www.ibm.com/xmlns/prod/sn">
	<id>urn:lsid:ibm.com:td:_Pplace33_RMain_D94913AFBEAB46DA8052576A1006611BC</id>
	<td:uuid>_Pplace33_RMain_D94913AFBEAB46DA8052576A1006611BC</td:uuid>
	<link href="dm/atom/library/_Pplace33_RMain/documenttypes/_Pplace33_RMain_D94913AFBEAB46DA8052576A1006611BC/entry" rel="self"/>
	<link href="LotusQuickr/place33/Main.nsf/h_Index/94913AFBEAB46DA8052576A1006611BC/?OpenDocument" rel="alternate"/>
	<link href="dm/atom/library/_Pplace33_RMain/documenttypes/_Pplace33_RMain_D94913AFBEAB46DA8052576A1006611BC/entry" rel="edit"/>
	<author>
		<uri>CN=QuickPlace/O=QuickPlace; uid=wpsadmin/cn=Users/l=Westford/st=Massachusetts/c=US/ou=Lotus/o=Software group/dc=ibm/dc=com</uri>
		<name>QuickPlace</name>
		<email></email>
	</author>
	<title type="text">Upload</title>
	<updated>2011-03-28T07:01:37Z</updated>
	<published>2010-01-04T18:34:52Z</published>
	<summary type="text">Upload</summary>
	<category term="documentType" scheme="tag:ibm.com,2006:td/type" label="documentType"></category>
	<td:defaultExtension></td:defaultExtension>
	<td:publishInFolder></td:publishInFolder>
	<td:template>94913AFBEAB46DA8052576A1006611BC</td:template>
	<td:propertySheetType>
		<entry>
			<id>urn:lsid:ibm.com:td:_Pplace33_RMain_D94913AFBEAB46DA8052576A1006611BC/propertySheetType</id>
			<td:uuid>_Pplace33_RMain_D94913AFBEAB46DA8052576A1006611BC/propertySheetType</td:uuid>
			<link href="dm/atom/library/_Pplace33_RMain/documenttypes/_Pplace33_RMain_D94913AFBEAB46DA8052576A1006611BC/entry" rel="self"/>
			<link href="LotusQuickr/place33/Main.nsf/h_Index/94913AFBEAB46DA8052576A1006611BC/?OpenDocument" rel="alternate"/>
			<link href="dm/atom/library/_Pplace33_RMain/documenttypes/_Pplace33_RMain_D94913AFBEAB46DA8052576A1006611BC/entry" rel="edit"/>
			<category term="propertysheettype" scheme="tag:ibm.com,2006:td/type" label="propertySheetType"></category>
			<author>
				<uri>CN=QuickPlace/O=QuickPlace; uid=wpsadmin/cn=Users/l=Westford/st=Massachusetts/c=US/ou=Lotus/o=Software group/dc=ibm/dc=com</uri>
				<name>QuickPlace</name>
				<email></email>
			</author>
			<title type="text">Upload</title>
			<updated>2011-03-28T07:01:37Z</updated>
			<summary type="text">Upload</summary>
			<content type="text">
				<?xml version="1.0" encoding="UTF-8"?>
				<meta:propertySheetTemplate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:clb="http://content.ibm.com/clb/1.0" xmlns:meta="http://metadata.model.xsd.clb.content.ibm.com/1.0">
					<meta:property xsi:type="meta:ClbPropertyType" dataType="string" dominoDataType="h_SingleAttachment" maxLength="512" multiple="false" propertyId="clb:h_SingleAttachment" propertyName="h_SingleAttachment" readonly="false" required="false" searchable="false">
						<meta:label label="SingleAttachment" lang="en"/>
						<meta:style name="ibm:textVariant" value="medium"/>
						<meta:defaultValue></meta:defaultValue>
					</meta:property>
					<meta:property xsi:type="meta:ClbPropertyType" dataType="string" dominoDataType="h_ShowPreview" maxLength="512" multiple="false" propertyId="clb:h_ShowPreview" propertyName="h_ShowPreview" readonly="false" required="false" searchable="false">
						<meta:label label="Show Preview" lang="en"/>
						<meta:style name="ibm:textVariant" value="medium"/>
						<meta:defaultValue>0</meta:defaultValue>
					</meta:property>
					<meta:property xsi:type="meta:ClbPropertyType" dataType="string" dominoDataType="h_Subject" maxLength="512" multiple="false" propertyId="clb:h_Name" propertyName="h_Name" readonly="false" required="true" searchable="false">
						<meta:label label="Name" lang="en"/>
						<meta:style name="ibm:textVariant" value="medium"/>
						<meta:defaultValue></meta:defaultValue>
					</meta:property>
					<meta:property xsi:type="meta:ClbPropertyType" dataType="string" dominoDataType="h_RichText" maxLength="512" multiple="false" propertyId="clb:PageBody" propertyName="PageBody" readonly="false" required="false" searchable="false">
						<meta:label label="Summary:" lang="en"/>
						<meta:style name="ibm:textVariant" value="medium"/>
						<meta:defaultValue></meta:defaultValue>
					</meta:property>
				</meta:propertySheetTemplate>
			</content>
			<td:constrainedMimeType/>
			<td:isExtracted>false</td:isExtracted>
		</entry>
	</td:propertySheetType>
	<td:versioning>EXPLICIT</td:versioning>
	<td:approvalEnabled>false</td:approvalEnabled>
	<td:approvalType>None</td:approvalType>
	<td:approvers/>
	<td:workflowType>h_Standard</td:workflowType>
	<td:expandGroupApprovers>false</td:expandGroupApprovers>
	<td:hidden>false</td:hidden>
</entry>