Filesets

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 Filesets

Request

This endpoint is used to check the status of a Fileset, eg. whether it is in a temporary or finalized state, and whether more files can be added to it. If files in a Fileset have been deleted or replaced, the previous versions will be shown in the Response.

More than one ID can be passed in the filterIds parameter to reduce the number of calls required if the caller needs to check the status of multiple Filesets and to assist with client-side caching.

filterIds 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}
curl -i -X GET \
  'https://developers-internal.tonicdm.com/_mock/tonicdm-product/fileset/filesets?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 Fileset in TonicDM.

datetimeCreatedstring(date-time)read-only

The date and time this Fileset record was created.

datetimeUpdatedstring(date-time)read-only

The date and time this Fileset record was last updated.

temporarybooleanread-only

Temporary FileSets are in process of being uploaded.

countFilesintegerread-only

The number of Files in the FileSet.

countTreeDepthintegerread-only

The maximum depth of sub-folders.

sizeintegerread-only

Total files size of all the Files.

]
Response
application/json
[
  {
    "id": "be26af2278974fddb5fcf67d83c10de3"
  }
]

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": [ … ]
  }
]

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