TonicDM Product API (0.0.5)

Main Product API

Download OpenAPI description
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

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

Edit Cloud Folder Child

Request

Change the name of an existing file or folder.

Bodyapplication/jsonrequired
fileCategorystring(fileCategory)

A list of functional categories for grouping files.

Default "none"
Enum"3d""audio-video""cad""calendar""contact""email""gis""image""pdf""presentations"
curl -i -X PATCH \
  https://developers-internal.tonicdm.com/_mock/tonicdm-product/fileset/cloudfilesystem-children \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "fileCategory": "3d"
  }'

Responses

Successfully updated the resource you sent

Response
No content

Delete Cloud Folder Child

Request

Delete a file or folder from the parent folder.

curl -i -X DELETE \
  https://developers-internal.tonicdm.com/_mock/tonicdm-product/fileset/cloudfilesystem-children \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successfully deleted the resource you requested

Response
No content

Upload cloud-hosted files

Request

Based on the IDs of files in a cloud file system, add those files to a TonicDM fileset. If the files are in different folders, the TonicDM system will determine the appropriate relative path (the common root).

The TonicDM user's token for the cloud platform must have access to the files in the cloud file system.

It should return success or failure for each file as it happens. Implementing a progress bar ???

Query
platformstringrequired

Defines the cloud platform to use.

Enum"egnyte""sharepoint""msgraph""procore""acc"
Example: platform=egnyte
cloudFileIdsArray of strings

Specifies a list of GUIDs of files in a cloud file system

Example: cloudFileIds={id},{id},{id}
filesetIdstring

Specifies the GUID of a Fileset

Example: filesetId=8e8aa42241794371ae9d0ed7b67a8c86
curl -i -X PUT \
  'https://developers-internal.tonicdm.com/_mock/tonicdm-product/fileset/cloud-file?cloudFileIds={id}%2C{id}%2C{id}&filesetId=8e8aa42241794371ae9d0ed7b67a8c86&platform=egnyte' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successfully retreived the files from the cloud file system and added them to the Fileset.

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" } ]

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