documents

Get a document by ID

Requires the DOCUMENT.VIEW permission.

get/v{version}/documents/{resourceId}

Request

  • Base URL: https://test.api.solvimon.com
  • URL: https://test.api.solvimon.com/v{version}/documents/{resourceId}
  • Auth: API key in header X-API-KEY

Path parameters

versionstring required

version

resourceIdstring required

The ID of the resource to be requested.

Headers

x-platform-idstring

Platform ID.

Response

OK

object_typestring nullable
idstring nullable
created_atstring nullable
namestring

The name of the document.

descriptionstring nullable

An optional description of the document.

content_typestring

Content type of the file. Supported: application/pdf, application/json, text/html, text/markdown, application/vnd.openxmlformats-officedocument.presentationml.presentation (pptx) and application/vnd.openxmlformats-officedocument.presentationml.template (potx). text/plain is accepted only for a markdown file, i.e. when the name ends in .md or .markdown.

contentstring

The file content, BASE64 encoded. Max 10MB, or 25MB for pptx and potx.

file_sizeinteger nullable

The file size in bytes.

downloaded_atstring nullable

Timestamp of the most recent download.

Changes

No recorded changes to this operation across all 1 revision of this API.