GET api/Download/Get?DocumentType={DocumentType}&Name={Name}&RealId={RealId}&FsId={FsId}&ProductFsId={ProductFsId}&Language={Language}
Endpoint for Data-Access-Plugin/Module
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
DocumentType |
filter parameter document type |
integer |
None. |
Name |
filter parameter name |
string |
None. |
RealId |
filter FS ID |
integer |
None. |
FsId |
Unique ID |
string |
None. |
ProductFsId |
filter parameter product id |
integer |
None. |
FilterByDocumentType |
determines whether document type filter is set |
boolean |
None. |
FilterByName |
determines whether name filter is set |
boolean |
None. |
FilterById |
determines whether id filter is set |
boolean |
None. |
FilterByProduct |
determines whether product filter is set |
boolean |
None. |
GetSingleMSDSDocument |
determines whether only a certain MSDS document is queried |
boolean |
None. |
Language |
Base class for filter parameters; Contains only language as parameter; |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
Download results
GenericJsonResultName | Description | Type | Additional information |
---|---|---|---|
count |
number of objects in return data |
integer |
None. |
totalAmountOfResults |
number of total results, not the results returned, especially for SolrSearch |
integer |
None. |
foundMore |
indicates whether there are more result objects than returned |
boolean |
None. |
data |
actual result data |
Object |
None. |
errorMessage |
if an error occured while processing request, this error message is filled string.empty means: no error occured |
string |
None. |
Response Formats
application/json, text/json
{ "count": 0, "totalAmountOfResults": 1, "foundMore": true, "data": {}, "errorMessage": "sample string 4" }