Get Diagram Details

From Creately Developer

Jump to: navigation, search

Contents

Description

This method allows you to get the details of a existing document.


Request

Request Details

URL https://creately.com/api/document
HTTP Method POST
Supported Authentication CT or SA
API Permissions This API call will not require any permissions
User Permissions The user will need to have access permission to the given document OR the given document should be a public document. When getting details of a public diagram user details of the diagram will not be sent.

Request Parameters

Parameter Description Required Default Value
action Must contain the value "getdetails". Will indicate that this is a Get Diagram Details action. Mandatory N/A
docid The unique identifier of the document for which the details are needed. Mandatory N/A
revision If the details of a specific revision is needed, it can be specified here. Optional Latest Revision
returnxml A boolean value indicating "true" or "false". Specifies if response should be a XML. Response will be sent in a XML if the value is true. Response will be sent in a serial string if the value is false. Optional true

NOTE: Parameters required by the authentication method must be provided. See what parameters are required in Authentication

Response

Response Details

Type XML
Content All details of the document will be returned on successful response.

Response Parameters

Tag Parent Tag Description
success creately-api-response Indicates if the request was successfully processed. May have true or false
doc-id creately-api-response The unique ID of the document.
name creately-api-response Name of the requested document.
desc creately-api-response The description text of the requested document.
tags creately-api-response The tags associated with the requested document. Tags are separated by commas (,)
type creately-api-response The type of diagram denoted by the Creately Diagram Type ID for the requested document.
creator-uid creately-api-response The ID of the user who created the requested document.
is-public creately-api-response Denotes if the requested document is published or not.
is-shared creately-api-response Denotes if the requested document is shared with anyone or not.
revision creately-api-response The revision details of the requested document will be within this XML tag.
no revision The revision number of the requested document. Will be a attribute of the "revision" XML tag.
total revision The total number of revisions available for the requested document. Will be a attribute of the "revision" XML tag. Note that the total can differ from the latest revision if revisions of the document have been deleted.
revision-uid revision The ID of the user who saved this revision of the requested document.
last-updated revision The date and time of the revision for the requested document.
save-comments revision This will contain any comments added during the save of the revision for the requested document.
thumbnail-url revision The URL of the thumbnail image of the requested diagram. The image would be of the dimensions 170px * 130px.
errorcode creately-api-response Will be available if the success parameter was false. Will contain a valid API Error code. Valid error codes are listed in API Error Codes
message creately-api-response Will be available if the success parameter was false. Will contain a string message for the error

Errors

Refer to Errors related to Document API calls in the Error Codes
Possible errors for Get diagram details method are: 1201, 1401, 1403, 1405, 1409

Examples

Example 1

Request

https://creately.com/api/document?apikey=2njk4234j23hkj23h4j2k3423jk4h&sig=jkn435654jk2j1kjh3mjk9&usr=johndoe@achme.com&action=getdetails&docid=f5dm432g

Response

	<creately-api-response>
            <success>true</success>
            <doc-id>f42u4hjwk4</doc-id>           
            <name>Flow of purchasing a Saas product</name>
            <desc>Explains the details and questions of purchasing a SAAS product</desc>
            <tags>purchase,saas,flow chart</tags>
            <type>flow-chart</type>
            <creator-uid>0d4fece0-0a10-4050-94e3-155270faceca</creator-uid>
            <is-public>false</is-public>
            <is-shared>true</is-shared>
            <revision no="8" total="8">    
                <revision-uid>0d4fece0-0a10-4050-94e3-155270faceca</revision-uid>
                <last-updated>2010-07-06 17:56:32</last-updated>
                <save-comments><save-comments>
                <thumbnail-url><thumbnail-url>
            </revision>
 	</creately-api-response>
Personal tools