Filesets
/
Get Fileset Thumbnails

TonicDM Product API (0.0.5)

Main Product API

Download OpenAPI description
tonicdm-product.json
tonicdm-product.yaml
Overview
URL https://developers-internal.tonicdm.com
Reg Prentice apisupport@tonicdm.com
License Proprietary
 Terms of Service
Languages
Servers
Mock server
https://developers-internal.tonicdm.com/_mock/tonicdm-product/
Server located in the USA
https://us-api.tonicdm.com/
Server located in Germany
https://de-api.tonicdm.com/
Server located in Ireland
https://ie-api.tonicdm.com/

Organizations & People

Data on People and Organizations (includes both staff and contacts, so these do not need to be looked up separately and combined).

Operations

Projects & Teams

Operations

Notes

Operations relating to the Notes that can be attached to various items.

Operations

Disciplines & Certification Definitions

Disciplines & Certification Definitions recognize areas of professional expertise.

Operations

Filesets

APIs to the Fileset module for accessing all files attached to objects in TonicDM.

Operations

Get Files

Request

Get Files stored in the Fileset module.

filterIds accepts one or more File IDs. filterFilesetIds accepts one or more FileSet IDs. At least one must be supplied.

Query
filterIdsArray of strings(CompactUUID)

Returns data for the specified GUIDs

Example: filterIds={id},{id},{id}
filterFilesetIdsArray of strings(CompactUUID)

Returns data for the specified Fileset GUIDs

Example: filterFilesetIds={id},{id},{id}
curl -i -X GET \
  'https://developers-internal.tonicdm.com/_mock/tonicdm-product/fileset/files?filterFilesetIds={id}%2C{id}%2C{id}&filterIds={id}%2C{id}%2C{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successfully read the resource you requested. One or more records are returned in the form of an array.

Bodyapplication/jsonArray [
idstring(uuid)read-only

the GUID of the File in TonicDM.

datetimeCreatedstring(date-time)read-only

The date and time this File record was created.

datetimeUpdatedstring(date-time)read-only

The date and time this File record was last updated.

statusstringread-only

The status of the File, with Inactive meaning it has been superceded (ie. another file with the same name was subsequently uploaded to the Fileset) removed from the Fileset.

Enum"Active""Inactive"
pathstringread-only

The relative path to the file (from the root of the Fileset).

filenamestringread-only

The name of the file (with extension).

sizeintegerread-only

The size of the file in bytes.

fileCategorystring(fileCategory)

A list of functional categories for grouping files.

Default "none"
Enum"3d""audio-video""cad""calendar""contact""email""gis""image""pdf""presentations"
]
Response
application/json
[
  {
    "id": "be26af2278974fddb5fcf67d83c10de3"
  }
]

Get Fileset Thumbnails

Request

Get thumbnails for files stored in the Fileset module.

Query
filterIdsArray of strings(CompactUUID)

Returns data for the specified GUIDs

Example: filterIds={id},{id},{id}
filterThumbnailSizestring

Returns thumbnail images of all pages of a document at the specified size

Enum"small""medium""large"
Example: filterThumbnailSize=small
curl -i -X GET \
  'https://developers-internal.tonicdm.com/_mock/tonicdm-product/fileset/thumbnails?filterIds={id}%2C{id}%2C{id}&filterThumbnailSize=small' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successfully read the resource you requested. One or more records are returned in the form of an array.

Bodyapplication/jsonArray [
fileIdstringrequired

The GUID of the file these thumbnails belong to.

thumbnailArrayArray of objects(Thumbnail)non-emptyrequired

an array of thumbnails for this file

thumbnailArray[].​pageintegerrequired

the page number represented by this thumbnail

thumbnailArray[].​sizeanyrequired

the thumbnail size

Default "active"
Enum"small""medium""large"
thumbnailArray[].​imageDatastring(byte)required

the thumbnail as a base64 encoded image/png

]
Response
application/json
[
  {
    "fileId": "be26af2278974fddb5fcf67d83c10de3",
    "thumbnailArray": [ … ]
  },
  {
    "fileId": "e4e60c6333cc46b68ba4e740ee7d637f",
    "thumbnailArray": [ … ]
  }
]

Get an Expiry URL

Request

Expiry URLs are used when sending download links in notifications or emails. An Expiry URL can be used to download a Fileset for a limited time (eg. 30 days). The owner of the Fileset can change the expiry date of the Expiry URL after the fact to reduce or extend the time the Fileset can be downloaded.

If the TonicDM back end is sending the notifications or emails, you do not need to use this endpoint. The TonicDM back end will automatically generate the Expiry URL and include it in the notification or email.

If you want to send a notification or email from your own system, you can use this endpoint to generate an Expiry URL for the Fileset.

There are no Request parameters for this endpoint. To associate the Expiry URL with a Fileset, you must include the Expiry ID in the request that creates the Workflow Item for which the Fileset is attached.

curl -i -X GET \
  https://developers-internal.tonicdm.com/_mock/tonicdm-product/fileset/expiry-url \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successfully returned an Expiry URL

Bodyapplication/json
expiryIdstring(uuid)read-only

The GUID of the expiry link.

expiryUrlstring(uri)read-only

The full URL for the download, including the HTTP server.

Response
application/json
{
  "expiry_id": "dea11ac43c5b4f35aacbd641d268670f",
  "expiry_url": "https://app.tonicdm.com/w/dea11ac43c5b4f35aacbd641d268670f"
}

Manual Uploading

APIs to the Fileset module for uploading files to the TonicDM cloud.

Operations

Cloud File Systems

Managing cloud file systems that TonicDM can connect to.

Operations

Correspondence

Managing Correspondence Data

Operations

File Transfers

APIs to the File Transfers Workflow module.

Operations

RFIs

APIs to the RFIs Workflow module.

Operations

Submittals

APIs to the Submittals Workflow module.

Operations

PCOs

APIs to the PCOs Workflow module.

Operations

COs

APIs to the COs Workflow module.

Operations

Tasks

APIs to the Tasks Workflow module.

Operations