Downloads a document based on document Id

GET {{baseUrl}}/public/api/projects/v1/dbs/:dbid/projects/:projid/documents/:docid?overlayid=<string>&lcid=<string>&export_type=<string>

The supplied document ID can refer to documents of various types:

  • a plain COMOS document (including reports)
  • a DDM (= versioned) document (in this case the latest version will be retrieved)
  • a particular version of a DDM (= versioned) document
  • a revision (in this case the parameter docid technically refers to COMOS device)
  • a redlining document of a revision
  • an additional document of a revision

Request Params

KeyDatatypeRequiredDescription
overlayidstringWorking Overlay Id
lcidstringLanguage Id
export_typestringExport type. At the moment the types 'report2pdf' and 'report2excel' are supported. Note that docid must refer to a report in this case.

HEADERS

KeyDatatypeRequiredDescription
Comos-API-Sessionstring(Required) Comos SessionId that needs to be passed with every request except Login
Acceptstring

RESPONSES

status: OK

{}