Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
XmlReturned fields
Possible values of the revision status element
READ permission is required on the document.
[This is preliminary documentation and is subject to change.]
Gets detailed data for a Content Studio document including its source code content.
Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
public string GetDetails( ConnectionId connectionId, SessionId sessionId, DocumentId documentId, int versionNumber )
Parameters
- connectionId
- Type: ContentStudioConnectionId
A value that identifies the web site - sessionId
- Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId). - documentId
- Type: ContentStudio.DocumentDocumentId
A value that identifies the document whose details should be displayed. - versionNumber
- Type: SystemInt32
The version of the document to return.Value Meaning -2 Returns the draft. If no draft exists the currently approved content is returned. -1 Returns the draft. If no draft exists a ContentStudio.CSException is thrown. 0 Returns the currently approved content. If no approved content exists a ContentStudio.CSException is thrown Any existing version number Returns the content of the specified version.
Return Value
Type: StringXml
<root> <status>0</status> <statustext>Success</statustext> <document> <result>Integer value</result> <resulttext>String value</resulttext> <elementcreateddate></elementcreateddate> <publishdate>Date value</publishdate> <archivedate>Date value</archivedate> <introduction>String value</introduction> <elementorder>Integer value</elementorder> <elementimage>String value</elementimage> <elementtarget>String value</elementtarget> <elementurl>String value</elementurl> <elementname>String value</elementname> <filename>String value</filename> <marking>String value</marking> <content>String value</content> <revision>Integer value</revision> <revisiondate>Date value</revisiondate> <elementcreatedby>String value</elementcreatedby> <contentcreatedby>String value</contentcreatedby> <revisedby>String value</revisedby> <modifiedby>String value</modifiedby> <modifieddate>String value</modifieddate> <contentcreateddate></contentcreateddate> <categoryid>Integer value</categoryid> <revisionstatus>Integer value</revisionstatus> <publishstatus>Integer value</publishstatus> <ischeckedoutbyid>Integer value</ischeckedoutbyid> <ischeckedoutbycaller>Bit value</ischeckedoutbycaller> <lastcheckout>Date value</lastcheckout> <checkedoutbyname>String value</checkedoutbyname> <filesize>String value</filesize> <contenttype>String value</contenttype> <bodyproperties>String value</bodyproperties> <headerproperties>String value</headerproperties> <keywords>String value</keywords> <isapproved>Bit value</isapproved> <isactivated>Bit value</isactivated> <isdeleted>Bit value</isdeleted> <isrejected>Bit value</isrejected> <isonrevision>Bit value</isonrevision> <isedittemplate>Bit value</isedittemplate> <ispresentationtemplate>Bit value</ispresentationtemplate> <sourcecodepreservation>Bit value</sourcecodepreservation> <documentusage>Integer value</documentusage> <lastused>Date value</lastused> <etforptid>Integer value</etforptid> <parentelementid>Integer value</parentelementid> <modulename>String value</modulename> <elementid>Integer value</elementid> <imagesavailable>Integer value</imagesavailable> <documentnr>Integer value</documentnr> <guoid>String value</guoid> <allowedfiletypes>String value</allowedfiletypes> <maxcontentsize>Integer value</maxcontentsize> <virtualpath>String value</virtualpath> <encoding>String value</encoding> <documentfilenamingconvention>Integer value</documentfilenamingconvention> <documentstatus>Integer value</documentstatus> <contentstatus>Integer value</contentstatus> <undelete_information categoryid="Integer value" parentelementid="Integer value" filename="String value" virtualpath="String value" /> </document> </root>
Field specifications:
Element path name | Value | Description |
---|---|---|
root/status | 0 | Indicating the outcome of the call. Always 0 (zero) |
root/statustext | Success | Indicating the textual outcome of the call. Always "Success" |
root/document | The document root node | |
root/document/result | 0 | Indicating the outcome of the call. Always 0 (zero) |
root/document/resulttext | Success | Indicating the textual outcome of the call. Always "Success" |
root/document/elementcreateddate | Date value | The date and time when the document was created. |
root/document/publishdate | Date value | The date and time value specifying when the document is published. |
root/document/archivedate | Date value | The date and time value specifying when the document is archived. Empty or missing indicating that there is no archive date. |
root/document/introduction | String value | Introduction data |
root/document/elementorder | Integer value | The order of the document within an hierarchy. Default is zero which means that Content Studio determines the sorting order. |
root/document/elementimage | String value | Extra data used when the document acts as a menu item. |
root/document/elementtarget | String value | Extra target data used when the document acts as a menu item. |
root/document/elementurl | String value | Extra url (link) data used when the document acts as a menu item. |
root/document/elementname | String value | The name (title) of the document. |
root/document/filename | String value | The name of the file that represents the document on disc. |
root/document/marking | String value | Short string data that can be used in the admin interface to categorize the document. |
root/document/content | String value | The content (source code) of the document. This is not the same as the content stored on disc. Not used with binary documents. |
root/document/revision | Integer value | The version number. The draft always has zero (0) as version number. |
root/document/revisiondate | Date value | A date and time value indicating when the version was approved. |
root/document/elementcreatedby | String value | The name of the user that created the document. |
root/document/contentcreatedby | String value | The name of the user that created the content loaded. |
root/document/revisedby | String value | The name of the user that approved the content. |
root/document/modifiedby | String value | The name of the user that last modified the document. |
root/document/modifieddate | String value | A date and time value indicating when the document last was modified. |
root/document/contentcreateddate | Date value | A date and time value indicating when the content loaded was created. |
root/document/categoryid | Integer value | The document's category identifier. |
root/document/revisionstatus | Integer value | See section below for details. |
root/document/publishstatus | Integer value | See section below for details. |
root/document/ischeckedoutbyid | Integer value | The internal identifier of the user that has the document checked out, or 0. |
root/document/ischeckedoutbycaller | Bit value | 1 if the caller has the document checked out; otherwise, 0 (zero). |
root/document/lastcheckout | Date value | A date and time value indicating when the document was checked out, or 0 (zero). |
root/document/checkedoutbyname | String value | The name of the user that has the document checked out, or empty |
root/document/filesize | String value | The size (in bytes) of the document stored on disc. |
root/document/contenttype | String value | The content type (mime type) of the document. |
root/document/bodyproperties | String value | The content of the document's body tag. For documents with meta data only; otherwise, empty. |
root/document/headerproperties | String value | The content of the document's header section. For documents with meta data only; otherwise, empty. |
root/document/keywords | String value | Searchable keywords associated with the document. |
root/document/isapproved | Bit value | 1 if the document is approved; otherwise 0 (zero). |
root/document/isactivated | Boolean value | 1 if the document is activated and can be shown; otherwise 0 (zero). If this value is not set the document is withdrawn. |
root/document/isdeleted | Boolean value | 1 if the document is deleted; otherwise 0 (zero). |
root/document/isrejected | Boolean value | 1 if the document is rejected; otherwise 0 (zero). |
root/document/isonrevision | Boolean value | 1 if the document is on versioning; otherwise 0 (zero). |
root/document/isedittemplate | Boolean value | 1 if the document is an edit template; otherwise 0 (zero). |
root/document/ispresentationtemplate | Boolean value | 1 if the document is an edit template; otherwise 0 (zero). |
root/document/sourcecodepreservation | Boolean value | 1 if the document uses source code preservation; otherwise 0 (zero). |
root/document/documentusage | Integer value | Not used in CS 5. |
root/document/lastused | Date value | Not used in CS 5. |
root/document/etforptid | Integer value | The identifier of the edit template for the presentation template; otherwise 0. |
root/document/parentelementid | Integer value | The document acting as parent document for the document, or the documentid if the document has no parent. |
root/document/modulename | String value | A value that is used to determine the type of document. |
root/document/elementid | Integer value | The document id. |
root/document/imagesavailable | Integer value | A value defines types of image processing version that exists for an image file. For more information see the ImagesAvailable enumeration |
root/document/documentnr | Integer value | A number that defines the creation order of a document within its category. |
root/document/guoid | String value | The document's Global unique object identifier, Guoid. |
root/document/allowedfiletypes | String value | The file extensions allowed for this document. The value is a comma separated list of file extension e.g. ".aspx,.asmx", or empty. The first file extension is the default file extension. |
root/document/maxcontentsize | Integer value | A value that limits the size of the content allowed for the document; 0 (zero) to indicate no limit. When the content limit has been reached an error is thrown when the document is updated. |
root/document/virtualpath | String value | The virtual path of the document. |
root/document/encoding | String value | The document encoding. |
root/document/documentfilenamingconvention | Integer | A value that specifies DocumentFileNamingConvention value. |
root/document/documentstatus | Integer | The status of the document. This is a bitmasked value. Added in version 5.4 |
root/document/contentstatus | Integer | The status of the content read. This is a bitmasked value. Added in version 5.4 |
root/document/undelete_information | Avaliable for deleted documents only. Added in version 5.7 | |
root/document/undelete_information@categoryid | Integer | The id of the original category of the document before it was moved to the recycle bin |
root/document/undelete_information@filename | String | The name of the original pathname of the document before it was moved to the recycle bin |
root/document/undelete_information@parentelementid | Integer | The id of the original parent element of the document before it was moved to the recycle bin |
root/document/undelete_information@virtualpath | String | The id of the original virtual of the document before it was moved to the recycle bin |
The revisionstatus element can have one of the following values and meaning.
Value | Name | Description |
---|---|---|
0 | None | The document has only a draft and is not deleted and has not been subject to version. |
1 | Rejected | The document was on versioning but was rejected. |
2 | Versioning | The document is on versioning |
3 | Deleted | The document is deleted |
4 | Approved | The document is approved. |
The publishstatus element which is defined in the PublishStatuses enumeration, can have one of the following values and meaning.
Value | Name | Description |
---|---|---|
0 | DraftOnly | The document exists only as a draft. |
5 | Expired | The document has expired. |
3 | InRecyclingBin | The document is in the Recycling bin. |
2 | Published | The document is published. |
1 | Queued | The document is waiting to be published. |
6 | Withdrawn | The document is withdrawn. |
The documentstatus element can have one of the following bit-values and meaning.
Value | Description |
---|---|
0x00000001 | Can be published |
0x00000020 | Is in the recycling bin |
0x00000080 | Workflow: for authoring |
0x00000100 | Workflow: authored |
0x00000200 | Draft exists |
0x00000800 | Is on workflow / versioning |
0x00004000 | Has been rejected |
0x00040000 | Is an edit template |
0x00080000 | Is a presentation template |
0x00200000 | Recently approved (for subscription services only) |
0x00400000 | Workflow: is for review |
0x00800000 | Workflow: has been reviewed |
0x01000000 | Workflow: for approval |
0x02000000 | Workflow: rejected by workflow server |
The contentstatus element can have one of the following bit-values and meaning.
Value | Description |
---|---|
0x00000000 | Draft |
0x00000001 | Approved |
Exceptions
Exception | Condition |
---|---|
CSDocumentNotFoundException | 1804 - The document could not be found. In version 5.4 this exception replaces the general CSException |
CSInvalidSessionException | Session is invalid. In version 5.4 this exception replaces the general CSException |
CSPermissionDeniedException | Permission denied. In version 5.4 this exception replaces the general CSException |
CSException |
Starting with version 5.4 the errors 1001, 1002 and 1804 are thrown as their more specific representations. |
SqlException | An error occurred when executing the command against the Content Studio database |
Content Studio permissions
See Also