Skip to main content

Get document content url

GET 
/documents/:documentId/url

Returns a URL for the document's contents; this URL will expire (the default is 48 hours)

Request​

Path Parameters

    documentId stringrequired

    Document Identifier

Query Parameters

    siteId string

    Site Identifier

    artifactId string

    Artifact Document Identifier

    versionKey string

    Version Key (version key required URL encoding)

    duration integer

    Indicates the number of hours request is valid for

    shareKey string

    Share Identifier

    inline boolean

    Request inline delivery. S3-backed SVG documents identified by content type or filename are always served as attachments.

    Default value: false
    bypassWatermark boolean

    Allow the by pass of watermark (only allowed by GOVERN / ADMIN permissions)

    Default value: false
    format string

    Possible values: [short]

    Return a shortlink URL when set to short; available as an Add-On Module

Responses​

200 OK

Response Headers

  • Access-Control-Allow-Origin

    string

  • Access-Control-Allow-Methods

    string

  • Access-Control-Allow-Headers

    string

Schema

    documentId string

    Document Identifier

    artifactId string

    Artifact Identifier

    url string

    Document content url

    headers

    object

Loading...