heilog.ch.Api

<back to all web services

GetEssencePreviewRequest

The following routes are available for this service:
GET/essence/preview
GetEssencePreviewRequest Parameters:
NameParameterData TypeRequiredDescription
EssenceIdquerylongNo
GetEssencePreviewResponse Parameters:
NameParameterData TypeRequiredDescription
EssenceformEssencePreviewDtoNo
EssencePreviewDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
NameformstringNo
SummaryformstringNo
TextAttachmentformstringNo
FileNameformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /essence/preview HTTP/1.1 
Host: heidak-api.test.exanic.ch 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"essence":{"id":0,"name":"String","summary":"String","textAttachment":"String","fileName":"String"}}