File Transfers

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

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

Get FileTransfers

Request

Get FileTransfers stored in the Workflow module.

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/workflow/filetransfers?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(CompactUUID)^[0-9a-fA-F]{32}$

UUID without hyphens (32 characters)

Example: "8e8aa42241794371ae9d0ed7b67a8c86"
datetimeCreatedstring(date-time)read-only

The date and time this Item was created.

datetimeUpdatedstring(date-time)read-only

[not implemented yet] The date and time this Item was last updated.

project_idstring^[0-9a-fA-F]{32}$
confidentialboolean
statusstring(Status)

Whether the item is active or inactive in TonicDM. Potentially the item could be (soft) deleted.

Default "active"
Enum"active""inactive""deleted"
stagestring
Enum"sent""expected_from_others""received""requested_from_us"
manual_received_datetimestring(date-time)

For File Transfers, this is ??

manual_response_datetimestring(date-time)

For File Transfers, this is ??

our_response_requiredboolean

This is true if this is an incoming request for us to send a FileTransfer to another party.

our_response_required_datestring(date)

The date by which we need to respond an incoming request for us to send a FileTransfer to another party.

our_titlestring
is_internal_forwardboolean

[not implemented yet] True if all the addressees in the FileTransfer are internal to the organization.

partsArray of objects(FileTransferPartWithId)
]
Response
application/json
[
  {
    "id": "be26af2278974fddb5fcf67d83c10de4"
  },
  {
    "id": "be26af2278974fddb5fcf67d83c10de3"
  }
]

Get FileTransfer Parts

Request

Get the details of Parts of FileTransfers stored in the Workflow module.

Query
filterIdsArray of strings(CompactUUID)

Returns data for the specified GUIDs

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

Returns data for the specified Parts of Workflow Items

Example: filterPartIds={PartId},{PartId},{PartId}
curl -i -X GET \
  'https://developers-internal.tonicdm.com/_mock/tonicdm-product/workflow/filetransfer-parts?filterIds={id}%2C{id}%2C{id}&filterPartIds={PartId}%2C{PartId}%2C{PartId}' \
  -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(CompactUUID)^[0-9a-fA-F]{32}$

UUID without hyphens (32 characters)

Example: "8e8aa42241794371ae9d0ed7b67a8c86"
partstring

The type of Part.

  • forward: A FileTransfer that was sent out unsolicited (not in response to an incoming request) / Part "status": "active"; or a FileTransfer Request that was sent out / Part "status": "request"
  • receive: An incoming FileTransfer that was received by us from another party / Part "status": "active"; or an incoming FileTransfer Request that was received by us / Part "status": "request"
  • response: A FileTransfer sent out by us in response to a FileTransfer Request we had received from another party / Part "status": "active"
  • return_of_forward: An incoming FileTransfer that was received by us in response to an outgoing request / Part "status": "active";
Enum"forward""receive""response""return_of_forward"
sourcestring

shows whether the Part was created by a user or the system (delivering a FileTransfer sent to you).

Enum"system""user"
statusstring(Status)

Whether the item is active or inactive in TonicDM. Potentially the item could be (soft) deleted.

Default "active"
Enum"active""inactive""deleted"
confidentialboolean
titlestring
messagestring
transmittalsArray of objects(Transmittal)
addresseesArray of objects(Addressee)
item_idstring

Change this to move the Part to a different Item. This could be used in the File Transfer to merge a request and a response into the same Item.

action_datetimestring(date-time)
disciplinesArray of objects(Discipline)
response_requiredboolean
response_required_datestring(date)
fileset_zonestring

The data center the Fileset is stored in.

fileset_idstring

The GUID of the Fileset in TonicDM.

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

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