You are here: Appendix M: Web API reference > GetDocument

GetDocument

Gets information about a specific revision of a single document.

Syntax

Request the latest revision of a document:

https://<ServerName>/BCEnterprise/api/getdocument.ashx?viewid=<ViewName>&DocID=<DocID>

Request specific revision of a single document:

https://<ServerName>/BCEnterprise/api/getdocument.ashx?viewid=<ViewName>&RevID=<RevID>
Parameters

Parameters are not case-sensitive.

Name

Description

DOCID

The unique Meridian Enterprise GlobalID value of the document. Required when REVID is not specified. Returns the current revision of the document.

REVID

The Meridian Enterprise VersionID value of the document. When specified, DOCID is ignored. Returns the specified revision of the document.

VIEWID

The Meridian Explorer View ID value from which to get the document information. The value was specified when the view was created as described in Creating and editing repository views.

Response Values

Value

Type

Description

DownloadUrl

URL

Location to download the document rendition in Adobe PDF format or empty if the document content is not available.

DownloadUrlSource

URL

Location to download the document in its original formator empty if the document content is not available.

GlobalID

String

The unique Meridian Enterprise GlobalID value of the document.

Name

String

The Meridian Enterprise display name of the document.

PropertiesUrl

URL

Location of the Meridian Explorer properties page of the document.

RevisionGlobalID

String

The unique Meridian Enterprise VersionID value of a specific revision of the document.

ViewerUrl

URL

Location to open the document in the Meridian Explorer viewer (if installed).

Example

Request:

https://MyServerName/BCEnterprise/api/getdocument.ashx?viewid=DOC_MyView&DocID={44611503-105A-11DD-0000-B406F7688C98}

Response:

{
"GlobalID":"{44611503-105A-11DD-0000-B406F7688C98}",
"RevisionGlobalID":"{5266D671-105B-11DD-0000-B406F7688C98}",
"Name":"0011-08-2400n001.dwg",
"DownloadUrlSource":"http://MYSERVER/bcenterpriseex/download?ViewID=DOC_B09E8\u0026RevID=12520\u0026CT=RevisionContent",
"DownloadUrl":"http://MYSERVER/bcenterpriseex/download?ViewID=DOC_B09E8\u0026RevID=12520\u0026CT=Rendition",
"ViewerUrl":"http://MYSERVER/bcenterpriseex/DOC_B09E8\u0026revisionid=12520\u0026content=true\u0026IsLatest=False",
"PropertiesUrl":"http://MYSERVER/bcenterpriseex/DOC_B09E8\u0026revisionid=12520\u0026content=false\u0026IsLatest=False"
}