Get Preview Document Stream
Get the preview version of the document content as a stream.
Retrieves a sanitized version if possible NsApiSlow threshold: 2000 ms.
Headers
Convert string references and multi-language values into a specified language (iso2) code.
Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
Specify the timezone code that you would like date/time responses converted to.
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Query Parameters
Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.
Body
DocumentId
GetPreviewDocumentStream: Get the preview version of the document content as a stream. Retrieves a sanitized version if possible
Response
OK
Document data intended for preview purposes Carrier object for DocumentPreview. Services for the DocumentPreview Carrier is available from the Document Agent.
The documents name
The mimetype of the stream
Size of the stream
Document data
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Field property dictionary mapping field names to field access rights.
Related topics
NSDocumentAgentGet Unsanitized Preview Document StreamGet Preview Attachment StreamGet Document StreamVerify Get Document Stream