Skip to content

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

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

Operations

People

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

Operations

Projects

The list of Projects for the customer.

Operations

Teams

The list of People associated with a Project.

Operations

Groups

The list of Groups associated with a Project.

Operations

Labels

Operations relating to the Labels that can be attached to various objects.

Operations

Notes

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

Operations

Disciplines

Disciplines are recognized areas of professional expertise.

Operations

Certifications

Certifications recognize areas of professional specialty or project accomplishments.

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

Initialize multi-part upload

Request

For large files (over 100Mb), initiate a multi-part upload with this endpoint, then call ... to get the URL to upload each chunk, then when all the chunks are uploaded call ... to finalize the upload.

This endpoint returns the AWS UploadId as a string that must be used in subsequent calls.

Security
OAuth2 or apiKeyAuth
Query
filesetIdstring

Specifies the GUID of a Fileset

Example: filesetId=8e8aa42241794371ae9d0ed7b67a8c86
contentTypestring

HTTP Media Content Type

filePathNameExtstring

Filename including optional relative path, name and file extension. No leading slash eg. path1/path2/name.ext

curl -i -X GET \
  'https://developers-internal.tonicdm.com/_mock/tonicdm-product/fileset/multi-part-initialize?filesetId=8e8aa42241794371ae9d0ed7b67a8c86&contentType=string&filePathNameExt=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successfully returned a presigned URL for uploading a file to AWS S3.

Bodyapplication/json
awsUploadIdstring
X-Amz-Algorithmstringread-only

The encryption algorithm.

X-Amz-Datestringread-only

Timestamp of the URL generation. Combine with X-Amz-Expires to determine the expiry time.

X-Amz-SignedHeadersstringread-only

X

X-Amz-Credentialstringread-only

X

X-Amz-Expiresintegerread-only

The number of seconds the URL will be valid. Combine with X-Amz-Date to determine the expiry time. The upload needs to be startedd before this time, but can run as long as needed to deliver the data.

X-Amz-Signaturestringread-only

X

Response
application/json
{
  "X-Amz-Algorithm": "AWS4-HMAC-SHA256",
  "X-Amz-Date": "20240823T224600Z",
  "X-Amz-SignedHeaders": "content-type%3Bhost",
  "X-Amz-Credential": "AKI3GAIOBE2IAUG5IZUA%2F20240823%2Fus-east-1%2Fs3%2Faws4_request",
  "X-Amz-Expires": 600,
  "X-Amz-Signature": "6c45fece459e8cf8f124c13eba64702b0f7b0fcb769ecaf397479f65e1204d80"
}

Get a Presigned URL for Uploading

Request

Presigned URLs are used to upload a file into the Fileset specified by the Fileset ID in the request.

  • For small files (under 100Mb), call this endpoint and upload the file to it.
  • For large files (over 100Mb), Initiate a multi-part upload with .. then call this endpoint to get the URL to upload each chunk, then when all the chunks are uploaded call ... to finalize the upload.

When the Presigned URL is used, the Response will include an etag which must be saved and submitted with the Finalize call.

Security
OAuth2 or apiKeyAuth
Query
filesetIdstring

Specifies the GUID of a Fileset

Example: filesetId=8e8aa42241794371ae9d0ed7b67a8c86
curl -i -X GET \
  'https://developers-internal.tonicdm.com/_mock/tonicdm-product/fileset/presigned-url?filesetId=8e8aa42241794371ae9d0ed7b67a8c86' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successfully returned a presigned URL for uploading a file to AWS S3.

Bodyapplication/json
X-Amz-Algorithmstringread-only

The encryption algorithm.

X-Amz-Datestringread-only

Timestamp of the URL generation. Combine with X-Amz-Expires to determine the expiry time.

X-Amz-SignedHeadersstringread-only

X

X-Amz-Credentialstringread-only

X

X-Amz-Expiresintegerread-only

The number of seconds the URL will be valid. Combine with X-Amz-Date to determine the expiry time. The upload needs to be startedd before this time, but can run as long as needed to deliver the data.

X-Amz-Signaturestringread-only

X

Response
application/json
{
  "X-Amz-Algorithm": "AWS4-HMAC-SHA256",
  "X-Amz-Date": "20240823T224600Z",
  "X-Amz-SignedHeaders": "content-type%3Bhost",
  "X-Amz-Credential": "AKI3GAIOBE2IAUG5IZUA%2F20240823%2Fus-east-1%2Fs3%2Faws4_request",
  "X-Amz-Expires": 600,
  "X-Amz-Signature": "6c45fece459e8cf8f124c13eba64702b0f7b0fcb769ecaf397479f65e1204d80"
}

Finalize multi-part upload

Request

For large files (over 100Mb), initiate a multi-part upload with .. , then call ... to get the URL to upload each chunk, then when all the chunks are uploaded call this endpoint to finalize the upload.

Security
OAuth2 or apiKeyAuth
Query
filesetIdstring

Specifies the GUID of a Fileset

Example: filesetId=8e8aa42241794371ae9d0ed7b67a8c86
curl -i -X GET \
  'https://developers-internal.tonicdm.com/_mock/tonicdm-product/fileset/multi-part-finalize?filesetId=8e8aa42241794371ae9d0ed7b67a8c86' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successfully returned a presigned URL for uploading a file to AWS S3.

Bodyapplication/json
X-Amz-Algorithmstringread-only

The encryption algorithm.

X-Amz-Datestringread-only

Timestamp of the URL generation. Combine with X-Amz-Expires to determine the expiry time.

X-Amz-SignedHeadersstringread-only

X

X-Amz-Credentialstringread-only

X

X-Amz-Expiresintegerread-only

The number of seconds the URL will be valid. Combine with X-Amz-Date to determine the expiry time. The upload needs to be startedd before this time, but can run as long as needed to deliver the data.

X-Amz-Signaturestringread-only

X

Response
application/json
{
  "X-Amz-Algorithm": "AWS4-HMAC-SHA256",
  "X-Amz-Date": "20240823T224600Z",
  "X-Amz-SignedHeaders": "content-type%3Bhost",
  "X-Amz-Credential": "AKI3GAIOBE2IAUG5IZUA%2F20240823%2Fus-east-1%2Fs3%2Faws4_request",
  "X-Amz-Expires": 600,
  "X-Amz-Signature": "6c45fece459e8cf8f124c13eba64702b0f7b0fcb769ecaf397479f65e1204d80"
}

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