Gets information about multiple documents.
Request:
http://<ServerName>/BCEnterprise/api/GetDocuments.ashx?VIEWID=<ViewName>&DOCFILTER=<FilterName>&pn=<PropertyName|PropertyName|...>
Parameters are not case-sensitive.
|
Name |
Description |
|---|---|
|
DOCFILTER or TAGFILTER |
The Meridian Explorer internal filter name from which to get the document information. |
|
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. |
|
PAGEINDEX |
Optional number of the page of results to return when many results are expected. |
|
PAGESIZE |
Optional maximum number of documents to return when many results are expected. By default, the first page will contain 100 documents. |
|
pn |
Optional names of the properties to return in the response. Separate property names with the vertical bar (|) character. |
The response includes a header and a structured list of the values for the matching documents.
| Value | Description |
|---|---|
|
PageIndex |
The number of the page of results in the response or 0 if paging is disabled. |
|
ActualCount |
The number of matching documents. |
The values for each matching document are described in the following table.
|
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 format or 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. |
|
Properties |
String | A list of name/value pairs for the properties listed by the pn parameter in the request. Values are returned in the appropriate JSON data type for the corresponding properties. |
|
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. |
|
RevisionNumber |
String |
The revision number of the document. |
|
StartDate |
DateTime | The UTC date the document was last released. |
|
TypeName |
String |
The Meridian Enterprise type of the document. |
|
ViewerUrl |
URL |
Location to open the document in the Meridian Explorer viewer (if installed). |
Request:
http://<ServerName>/BCEnterprise/api/GetDocuments.ashx?VIEWID=DOC_B09E8&DOCFILTER=MyFilter&pn=Custom.Discipline|Custom.Part
Response:
{"PageIndex":0,"ActualCount":2,"Documents":
[
{
"GlobalID":"{44611503-105A-11DD-0000-B406F7688C98}",
"RevisionGlobalID":"{5266D671-105B-11DD-0000-B406F7688C98}",
"Name":"0011-08-2400n001.dwg",
"RevisionNumber":"A",
"TypeName":"Drawing",
"StartDate":"\/Date(1290523017457)\/",
"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",
"Properties":[{"Name":"Custom.Discipline","Value":"Electrical"},
{"Name":"Custom.Part","Value":"2400"}]},
{"GlobalID":"{95E6A33C-F13E-11DD-0000-B406F7688C98}",
"RevisionGlobalID":"{1B0B1337-7868-11DF-0000-B406F7688C98}",
"Name":"0011-07-2000n001.xls",
"RevisionNumber":"B",
"TypeName":"Drawing",
"StartDate":"\/Date(1276604294360)\/",
"DownloadUrlSource":"http://MYSERVER/bcenterpriseex/download?ViewID=DOC_B09E8\u0026RevID=12523\u0026CT=RevisionContent",
"DownloadUrl":"http://MYSERVER/bcenterpriseex/download?ViewID=DOC_B09E8\u0026RevID=12523\u0026CT=Rendition",
"ViewerUrl":"http://MYSERVER/bcenterpriseex/DOC_B09E8\u0026revisionid=12523\u0026content=true\u0026IsLatest=False",
"PropertiesUrl":"http://MYSERVER/bcenterpriseex/DOC_B09E8\u0026revisionid=12523\u0026content=false\u0026IsLatest=False",
"Properties":[{"Name":"Custom.Discipline","Value":"Electrical"},
{"Name":"Custom.Part","Value":"2000" }]}
]
}