What are Rendition Requests?

→ "Try it out - API Component "MultiView"
→ check GitHub Python calls | Java Script calls | Java calls | Postman collection


yuuvis® API offers methods to generate renditions from uploaded documents (objects). With the methods available, you can render native files into PDFs, PNG thumbnails, plain text, or receive a summary of an object’s rendition information.

How does it work?

With yuuvis® API, you have different methods to get a rendition or rendition information via an document’s object ID.

  • "Get PDF rendition" endpoint (GET …/pdf) | "Get PDF rendition (specified version)" endpoint (GET …/versions/…/pdf)

    This request returns a PDF rendition of the content of the object that matches the object ID you specified in the request.
    Note: The returned PDF document cannot be displayed within the Azure portal. Please use another tool, such as Postman, to download the PDF rendition file.

  • "Get image rendition" endpoint (GET …/slide) | Get image rendition (specified version)" endpoint (GET …/versions/…/slide)

    This request returns a PNG rendition of the first page of the content of the object that matches the object ID you specified in the request. This PNG file is a small preview of the document. Its maximum dimensions are 256x256.

  • "Get text rendition" endpoint (GET …/text) | "Get text rendition (specified version)" endpoint (GET …/versions/…/text)

    This request returns a text rendition of the content of the object that matches the object ID you specified in the request.

  • "Get extraction rendition" endpoint (GET …/extract)

    This request extracts and returns all metadata from the document (object) that matches the objectId you specified in the request.

Responses

Status Code Meaning
200 OK
401 Unauthorized
404 Not Found

What file types can be passed into the API

...while remaining compatible with the rendering and searching functionalities?

Rendering (rendition) relies on the TextExtractor service, which decides whether or not to create a rendition based on the suffix of a file (i.e. .txt files can be read and re-rendered, whereas .json files will be ignored). Full-text-searching for file contents also works for a limited variety of supported document formats by our content-analyzer service. It determines, based on the content structure, whether full text indexing is possible. The content-analyzer as well as the rendition service can theoretically be configured to accept additional content types ...

Supported Mimetypes (configuration file of the content-analyzer):
            pdf:
            - '^(application/pdf)'
            text:
            - '^(text/plain)'
            - '^(text/csv)'
            email:
            - '^(application/vnd.ms-outlook)'
            - '^(message/rfc822)'
            office:
            - '^(application/vnd.ms-[^o])'
            - '^(application/vnd.visio)'
            - '^(application/vnd.openxmlformats)'
            - '^(application/rtf)$'
            - '^(application/ms)'
            html:
            - '^(text/html)'
            rtf:
            - '^(application/rtf)$'

Extraction service

The extraction service can read out XMP, EXIF and other data from media and Office files. This data is then mapped to OS tags and standardized.

Media and Office Files

Mapping to OS:Title
(type [string]):

Mapping to OS:Subject
(type [string]):

Mapping to OS:Keywords
(type [sequence]):

Mapping to OS:Comments
(type [sequence]):

  • FlashPix:Title
  • XML:Title
  • PDF:Title
  • XMP-pdf:Title
  • XMP-dc:Title
  • IFD0:XPTitle
  • PNG:Title
  • XMP-PixelLive:Title
  • PostScript:Title
  • XMP-xmp:Title
  • Microsoft:Title
  • ASF:Title
  • Vorbis:Title
  • Matroska:Title
  • ID3:Title
  • QuickTime:Title
  • FlashPix:Subject
  • PDF:Subject
  • XMP-pdf:Subject
  • XMP-dc:Subject
  • XMP-xmpMM:Subject
  • IFD0:XPSubject
  • PostScript:Subject
  • Microsoft:Subject
  • FlashPix:Keywords
  • XML:Keywords
  • PDF:Keywords
  • XMP-pdf:Keywords
  • IFD0:XPKeywords
  • XMP-acdsee:Keywords
  • PostScript:Keywords
  • IPTC:Keywords
  • XMP-xmp:Keywords
  • QuickTime:Keywords
  • FlashPix:Comments
  • ExifIFD:UserComment
  • XML:Comment
  • XMP-exif:UserComment
  • File:Comment
  • IFD0:XPComment
  • PNG:Comment
  • XMP-PixelLive:Comments
  • Microsoft:Comment
  • Vorbis:Comment
  • AIFF:Comment
  • ID3:Comments
  • QuickTime:Comment

Mapping to OS:LastModifiedBy
(type [string]):

Mapping to OS:CreateDate
(type [date]):

Mapping to OS:ModifyDate
(type [date]):

Mapping to OS:PageCount
(type [integer]):

  • FlashPix:LastModifiedBy
  • XML:LastModifiedBy
  • Microsoft:ModifiedBy
  • ASF:ModifiedBy
  • FlashPix:CreateDate
  • ExifIFD:CreateDate
  • XML:CreateDate
  • PDF:CreateDate
  • XMP-pdf:CreationDate
  • File:CreateDate
  • System:FileCreateDate
  • PNG:CreateDate
  • XMP-photoshop:DateCreated
  • PostScript:CreateDate
  • IPTC:DateCreated
  • XMP-xmp:CreateDate
  • Microsoft:DateCreated
  • Flash:CreateDate
  • QuickTime:CreateDate
  • QuickTime:CreationDate
  • FlashPix:ModifyDate
  • XML:ModifyDate
  • PDF:ModifyDate
  • XMP-pdf:ModDate
  • System:FileModifyDate
  • IFD0:ModifyDate
  • PNG:ModDate
  • PostScript:ModifyDate
  • XMP-xmp:ModifyDate
  • Microsoft:DateModified
  • QuickTime:ModifyDate
  • FlashPix:Pages
  • XML:Pages
  • PDF:PageCount
  • PostScript:Pages
  • Microsoft:Pages

Mapping to OS:ImageWidth
(type [integer]):

Mapping to OS:ImageHeight
(type [integer]):

Mapping to OS:Author
(type [string]):

Mapping to OS:CodePage
(type [string]):

  • FlashPix:ImageWidth
  • File:ImageWidth
  • ExifIFD:ExifImageWidth
  • ExifIFD:ImageWidth
  • Track*:ImageWidth
  • XMP-exif:ExifImageWidth
  • File:ImageWidth
  • XMP-tiff:ImageWidth
  • Photoshop:ImageWidth
  • IFD0:ImageWidth
  • BMP:ImageWidth
  • PNG:ImageWidth
  • XMP-svg:ImageWidth
  • IPTC:IPTCImageWidth
  • XMP-xmp:PageImageWidth
  • XMP-tiff:ImageWidth
  • MPEG:ImageWidth
  • Flash:ImageWidth
  • ASF:ImageWidth
  • Theora:ImageWidth
  • Matroska:ImageWidth
  • H264:ImageWidth
  • QuickTime:SourceImageWidth
  • FlashPix:ImageHeight
  • ExifIFD:ExifImageHeight
  • ExifIFD:ImageHeight
  • Track*:ImageHeight
  • XMP-exif:ExifImageHeight
  • File:ImageHeight
  • XMP-tiff:ImageHeight
  • Photoshop:ImageHeight
  • IFD0:ImageHeight
  • BMP:ImageHeight
  • PNG:ImageHeight
  • XMP-svg:ImageHeight
  • IPTC:IPTCImageHeight
  • XMP-xmp:PageImageHeight
  • XMP-tiff:ImageHeight
  • MPEG:ImageHeight
  • Flash:ImageHeight
  • ASF:ImageHeight
  • Theora:ImageHeight
  • Matroska:ImageHeight
  • H264:ImageHeight
  • QuickTime:SourceImageHeight
  • FlashPix:Author
  • XML:Author
  • PDF:Author
  • XMP-pdf:Author
  • IFD0:XPAuthor
  • PNG:Author
  • XMP-acdsee:Author
  • XMP-PixelLive:Author
  • PostScript:Author
  • XMP-xmp:Author
  • Microsoft:Author
  • ASF:Author
  • AIFF:Author
  • QuickTime:Author
  • FlashPix:CodePage

Mapping to OS:Creator
(type [string]):

Mapping to OS:Description
(type [string]):

Mapping to OS:FileSize
(type [integer]):

Mapping to OS:FileType
(type [string]):

  • PDF:Creator
  • XMP-pdf:Creator
  • XMP-dc:Creator
  • File:Creator
  • PostScript:Creator
  • Microsoft:Creator
  • Flash:CreatedBy
  • XMP-dc:Description
  • File:Image*Description
  • IFD0:ImageDescription
  • PNG:Description
  • XMP-xmp:Description
  • XMP-tiff:ImageDescription
  • Microsoft:Description
  • ASF:Description
  • Vorbis:Description
  • QuickTime:Description
  • System:FileSize
  • Microsoft:FileSize
  • ASF:FileSize
  • File:FileType
  • Microsoft:FileType
  • ID3:FileType

Mapping to OS:MimeType
(type [string]):

Mapping to OS:ColorType
(type [string]):

Mapping to OS:Artist
(type [string]):

Mapping to OS:BitsPerSample
(type [integer]):

  • File:MIMEType
  • PNG:ColorType
  • XMP-tiff:Artist
  • IFD0:Artist
  • PNG:Artist
  • XMP-tiff:Artist
  • Microsoft:Artist
  • ASF:AlbumArtist
  • Vorbis:Artist
  • ID3:Artist
  • QuickTime:Artist
  • File:BitsPerSample
  • XMP-tiff:BitsPerSample
  • IFD0:BitsPerSample

Mapping to OS:Compression
(type [string]):

Mapping to OS:PhotometricInterpretation
(no type):

Mapping to OS:Orientation
(type [string]):

Mapping to OS:Copyright
(type [string]):

  • File:Compression
  • XMP-tiff:Compression
  • IFD0:Compression
  • BMP:Compression
  • PNG:Compression
  • XMP-tiff:Compression
  • QuickTime:Compression
  • XMP-tiff:PhotometricInterpretation
  • IFD0:PhotometricInterpretation
  • XMP-tiff:PhotometricInterpretation
  • FlashPix:SpatialOrientation
  • File:Orientation
  • XMP-tiff:Orientation
  • IFD0:Orientation
  • IPTC:ImageOrientation
  • XMP-tiff:Orientation
  • Microsoft:Orientation
  • FlashPix:Copyright
  • XML:Copyright
  • XMP-pdf:Copyright
  • File:Copyright
  • XMP-tiff:Copyright
  • Photoshop:CopyrightFlag
  • IFD0:Copyright
  • PNG:Copyright
  • XMP-PixelLive:Copyright
  • PostScript:Copyright
  • XMP-tiff:Copyright
  • Microsoft:Copyright
  • ASF:Copyright
  • Vorbis:Copyright
  • AIFF:Copyright
  • ID3:Copyright
  • QuickTime:Copyright

Mapping to OS:CameraLabel
(type[string]):

Mapping to OS:GPSVersionID
(no type):

Mapping to OS:GPSLatitudeRef
(no type):

Mapping to OS:GPSLatitude
(no type):

  • IFD0:CameraLabel
  • XMP-exif:GPSVersionID
  • GPS:GPSVersionID
  • GPS:GPSLatitudeRef
  • XML:GPSLatitude
  • XMP-exif:GPSLatitude
  • GPS:GPSLatitude

Mapping to OS:GPSLongitudeRef
(no type):

Mapping to OS:GPSAltitudeRef
(no type):

Mapping to OS:GPSAltitude
(no type):

Mapping to OS:GPSTimeStamp
(no type):

  • GPS:GPSLongitudeRef
  • XMP-exif:GPSAltitudeRef
  • GPS:GPSAltitudeRef
  • XMP-exif:GPSAltitude
  • GPS:GPSAltitude
  • GPS:GPSTimeStamp

Mapping to OS:GPSSatellites
(no type):

Mapping to OS:GPSStatus
(no type):

Mapping to OS:GPSMeasureMode
(no type):

Mapping to OS:GPSDOP
(no type):

  • XMP-exif:GPSSatellites
  • GPS:GPSSatellites
  • XMP-exif:GPSStatus
  • GPS:GPSStatus
  • GPS:GPSMeasureMode
  • XMP-exif:GPSDOP
  • GPS:GPSDOP

Mapping to OS:GPSSpeedRef
(no type):

Mapping to OS:GPSSpeed
(no type):

Mapping to OS:GPSTrackRef
(no type):

Mapping to OS:GPSTrack
(no type):

  • XMP-exif:GPSSpeedRef
  • GPS:GPSSpeedRef
  • XMP-exif:GPSSpeed
  • GPS:GPSSpeed
  • XMP-exif:GPSTrackRef
  • GPS:GPSTrackRef
  • XMP-exif:GPSTrack
  • GPS:GPSTrack

Mapping to OS:GPSImgDirectionRef
(no type):

Mapping to OS:GPSImgDirection
(no type):

Mapping to OS:GPSMapDatum
(no type):

Mapping to OS:GPSDestLatitudeRef
(no type):

  • XMP-exif:GPSImgDirectionRef
  • GPS:GPSImgDirectionRef
  • XMP-exif:GPSImgDirection
  • GPS:GPSImgDirection
  • XML:GPSMapDatum
  • XMP-exif:GPSMapDatum
  • GPS:GPSMapDatum
  • GPS:GPSDestLatitudeRef

Mapping to OS:GPSDestLatitude
(no type):

Mapping to OS:GPSDestLongitudeRef
(no type):

Mapping to OS:GPSDestLongitude
(no type):

Mapping to OS:GPSDestBearingRef
(no type):

  • XMP-exif:GPSDestLatitude
  • GPS:GPSDestLatitude
  • GPS:GPSDestLongitudeRef
  • XMP-exif:GPSDestLongitude
  • GPS:GPSDestLongitude
  • XMP-exif:GPSDestBearingRef
  • GPS:GPSDestBearingRef

Mapping to OS:GPSDestBearing
(no type):

Mapping to OS:GPSDestDistance
(no type):

Mapping to OS:GPSProcessingMethod
(no type):

Mapping to OS:GPSArealInformation
(no type):

  • XMP-exif:GPSDestBearing
  • GPS:GPSDestBearing
  • XMP-exif:GPSDestDistance
  • GPS:GPSDestDistance
  • XMP-exif:GPSProcessingMethod
  • GPS:GPSProcessingMethod
  • XMP-exif:GPSArealInformation
  • GPS:GPSArealInformation

Mapping to OS:GPSDateStamp
(no type):

Mapping to OS:GPSDifferential
(no type):

Mapping to OS:GPSHPositioningError
(no type):

Mapping to OS:GPSAreaInformation
(no type):

  • GPS:GPSDateStamp
  • XMP-exif:GPSDifferential
  • GPS:GPSDifferential
  • XMP-exif:GPSHPositioningError
  • GPS:GPSHPositioningError
  • XMP-exif:GPSAreaInformation
  • GPS:GPSAreaInformation

Mapping to OS:GPSDestDistanceRef
(no type):

Mapping to OS:GPSLongitude
(no type):

Mapping to OS:GPSDateTime
(no type):

Mapping to OS:Genre
(type [string]):

  • XMP-exif:GPSDestDistanceRef
  • GPS:GPSDestDistanceRef
  • XML:GPSLongitude
  • XMP-exif:GPSLongitude
  • GPS:GPSLongitude
  • XMP-exif:GPSDateTime
  • XMP-PixelLive:Genre
  • Microsoft:Genre
  • ASF:Genre
  • Vorbis:Genre
  • ID3:Genre
  • QuickTime:Genre

Mapping to OS:FrameRate
(type [integer]):

Mapping to OS:AudioFormat
(no type):

Mapping to OS:Bitrate
(no type):

Mapping to OS:AudioBitrate
(no type):

  • IFD0:FrameRate
  • Microsoft:FrameRate
  • MPEG:FrameRate
  • Flash:FrameRate
  • ASF:VideoFrameRate
  • Theora:FrameRate
  • Matroska:FrameRate
  • H264:VideoFrameRate
  • QuickTime:VideoFrameRate
  • Microsoft:AudioFormat
  • QuickTime:AudioFormat
  • Microsoft:Bitrate
  • Microsoft:AudioBitrate
  • Flash:AudioBitrate

Mapping to OS:Duration
(no type):

Mapping to OS:VideoCompression
(no type):

Mapping to OS:AspectRatio
(no type):

Mapping to OS:AudioLayer
(no type):

  • Microsoft:Duration
  • Flash:Duration
  • ASF:Duration
  • Matroska:Duration
  • ID3:Duration
  • QuickTime:Duration
  • Microsoft:VideoCompression
  • Photoshop:PixelAspectRatio
  • MPEG:AspectRatio
  • Theora:PixelAspectRatio
  • MPEG:AudioLayer

Mapping to OS:SampleRate
(no type):

Mapping to OS:VideoBitrate
(no type):

Mapping to OS:VideoEncoding
(no type):

Mapping to OS:AudioSampleRate
(no type):

  • MPEG:SampleRate
  • Vorbis:SampleRate
  • AIFF:SampleRate
  • MPEG:VideoBitrate
  • Flash:VideoBitrate
  • Theora:NominalVideoBitrate
  • Flash:VideoEncoding
  • Flash:AudioSampleRate
  • ASF:AudioSampleRate
  • QuickTime:AudioSampleRate

Mapping to OS:AudioEncoding
(no type):

Mapping to OS:Album
(type [string]):

Mapping to OS:Track
(no type):

  • Flash:AudioEncoding
  • ASF:AudioCodecName
  • ASF:AlbumTitle
  • Vorbis:Album
  • ID3:Album
  • QuickTime:Album
  • ASF:Track
  • Vorbis:TrackNumber
  • Matroska:TrackNumber
  • ID3:Track
  • QuickTime:Track

E-Mails

Mapping to OS:Subject
(type [string]):

Mapping to OS:Title
(type [string]):

Mapping to OS:MailBody
(type [string]):

Mapping to OS:MailFrom
(type [string]):

  • dc:title
  • title
  • dc:description
  • subject

Use OS:Subject for a mapping to the subject of an e-mail.

If you change the subject of this e-mail in the client, this field makes sure that the change is applied.

  • subject

The OS:Title tag contains the title of the conversation.

  • Contains the e-mail body.
    EML, IMA and MSG are currently supported.
  • From:RFC822
  • From:RFC822Ex
  • From:NameOnly
  • From
  • Message-From
  • meta:author
  • dc:creator

Mapping to OS:MailTo
(type [string]):

Mapping to OS:MailCc
(type [string]):

Mapping to OS:MailBcc
(type [string]):

Mapping to OS:MimeType
(type [string]):

  • To:RFC822
  • To:RFC822Ex
  • To:NameOnly
  • To
  • Message-To
  • Message-Recipient-Address
  • CC:RFC822
  • CC:RFC822Ex
  • CC:NameOnly
  • CC
  • Message-Cc
  • Bcc:RFC822
  • Bcc:RFC822Ex
  • Bcc:NameOnly
  • Bcc
  • Message-Bcc
  • Content-Type

Mapping to OS:MailType
(type [string]):

Mapping to OS:MailDate
(type [date]):

Mapping to OS:MailAttachments
(type [string]):

Mapping to OS:MailAttachmentsText
(type [string]):

  • Content-Type
  • Creation-Date
  • meta:creation-date
  • dcterms:created
  • Contains all names of attachments, separated by semicolons.
  • Contains all texts of attachments that were extracted.

Mapping to OS:HasMailAttachments
(type [boolean]):

Mapping to OS:MessageId
(type [string]):



  • hasmailattachments
  • Message-ID


Description of E-mail Address Formats

For the processing of .msg files, the mappings OS:MailFrom, OS:MailTo, OS:MailCc, OS:MailBcc support different formats. All necessary information is extracted from the msg to be able to describe the participating mailboxes in the following formats:

  • RFC822: e-mail address only. Example: user@domain.com
  • RFC822Ex: the name in double quotation marks followed by RFC822 in brackets. Example: "Username" <user@domain.com>
  • NameOnly: only the name without double quotation marks. Example: Username

For the processing of .eml files, the above mentioned date are not prefilled and the next position is mapped (e.g., 'From' or 'Message-From').

Configuring the Mapping List

The mapping is configured in the mapping.lst file. You can add further metadata mappings by making additional entries in the mapping.lst file. The use of wildcards (*) is permitted. The mapping of metadata follows the first-wins principle, i.e. when processing the metadata of media and Office files, for each OS tag the value of the first matching metadata is transferred to the tag. A mapping of a single piece of metadata to several OS tags can be achieved by making multiple entries for the respective tags.

OS tags can also contain information about the type (notation: [type]). The type can be either double, string, date, boolean, integer, or sequence. For OS tags of type sequence, all entries mapped to this tag are linked together to a sequence of comma-separated values. If no type is specified, the default type is NONE. All resulting entries of OS tags are standardized, if possible to do so by automation. I.e., number formats are changed according to the US-English notation, date formats are changed to ISO 8601 notation {YYYY-MM-DD}T{hh:mm:ss} {±hh:mm}{Z}.

Mappings are also possible for invoices with attached ZUGFeRD data in XML format. These mappings are configured in the zugferdmapping.lst file. XML elements to be mapped are defined using xPath expressions. XML values mapped to a ZUGFeRD tag, begin with prefix “FERD:”. Similar to OS tags, the tags can contain type information. The same rules apply. Multiple mappings are not permitted for FERD tags (except for type sequence). If a multiple mapping exists, no FERD tags are returned for the entire document, because otherwise important invoice data can be lost. A multiple mapping results in an error code (FERD:ErrorCode) and error description (FERD:ErrorDescription) in the result JSON.