Skip to content
RFIs
/
Pull one RFI from a 3rd party system.

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

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

Pull an RFI List from a 3rd party system.

Request

Returns basic information for the list of RFIs available in a 3rd party system (e.g. Procore). The TonicDM user's token for the cloud platform must be set up and have access to the resources in the 3rd party system.

Security
OAuth2 or apiKeyAuth
Query
platformstringrequired

Defines the cloud platform to use.

Enum"egnyte""sharepoint""msgraph""procore""acc"
Example: platform=egnyte
searchQuerystring(JSON)

A JSON-encoded string containing the query options.

Example: searchQuery={"example"}
pageSizeinteger[ 1 .. 1000 ]

The number of results to return per page

Default 50
Example: pageSize=100
pageNumberinteger

Which page of the results to return

Example: pageNumber=1
sortDirectionstring

The sort direction for the results

Enum"asc""desc"
curl -i -X GET \
  'https://developers-internal.tonicdm.com/_mock/tonicdm-product/workflow/rfi-integrations-list?platform=egnyte&searchQuery={%22example%22}&pageSize=100&pageNumber=1&sortDirection=asc' \
  -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. The TonicDM user's token for the cloud platform must be set up and have access to the resources in the 3rd party system.

Bodyapplication/jsonArray [
3rdPartyIdstring[ 1 .. 128 ] charactersread-only

The ID of the record in the 3rd party system.

recievedDatetimestring(date-time)read-only

The date and time this record was sent to the User's organization. This value might be explicitly passed by the 3rd party system, or a substitute value might be determined by Tonic if the Sent datetime cannot be found. If this is an empty string, the datetime that it was sent to (recieved by) the User's organization could be determined.

statusstringread-only
numberstringread-only
revisionstringread-only
titlestring[ 1 .. 64 ] charactersread-only

The title or subject of the record in the 3rd party system.

]
Response
application/json
[
  {
    "3rdPartyId": "string",
    "recievedDatetime": "2019-08-24T14:15:22Z",
    "status": "string",
    "number": "string",
    "revision": "string",
    "title": "string"
  }
]

Pull one RFI from a 3rd party system.

Request

Returns detailed information for one RFI available in a 3rd party system (e.g. Procore). The TonicDM user's token for the cloud platform must be set up and have access to the resources in the 3rd party system.

Security
OAuth2 or apiKeyAuth
Query
platformstringrequired

Defines the cloud platform to use.

Enum"egnyte""sharepoint""msgraph""procore""acc"
Example: platform=egnyte
searchQuerystring(JSON)

A JSON-encoded string containing the query options.

Example: searchQuery={"example"}
pageSizeinteger[ 1 .. 1000 ]

The number of results to return per page

Default 50
Example: pageSize=100
pageNumberinteger

Which page of the results to return

Example: pageNumber=1
sortDirectionstring

The sort direction for the results

Enum"asc""desc"
curl -i -X GET \
  'https://developers-internal.tonicdm.com/_mock/tonicdm-product/workflow/rfi-integrations?platform=egnyte&searchQuery={%22example%22}&pageSize=100&pageNumber=1&sortDirection=asc' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successfully read the resource you requested. The TonicDM user's token for the cloud platform must be set up and have access to the resources in the 3rd party system.

Bodyapplication/jsonArray [
datetimeCreatedstring(date-time)read-only

The date and time this record was created in the 3rd Party System.

datetimeUpdatedstring(date-time)read-only

The date and time this record was last updated in the 3rd Party System.

3rdPartyIdstring[ 1 .. 128 ] charactersread-only

The ID of the record in the 3rd party system.

recievedDatetimestring(date-time)read-only

The date and time this record was sent to the User's organization from the 3rd Party System. This value might be explicitly passed by the 3rd party system, or a substitute value might be determined by Tonic if the Sent datetime cannot be found. If this is an empty string, the datetime that it was sent to (recieved by) the User's organization could be determined.

statusstringread-only
numberstringread-only
revisionstringread-only
titlestring[ 1 .. 64 ] charactersread-only

The title or subject of the record in the 3rd party system.

messagestringread-only

The message accompanying this transaction, in the manner of the body of an email.

addresseesArray of objectsread-only
]
Response
application/json
[
  {
    "datetimeCreated": "2019-08-24T14:15:22Z",
    "datetimeUpdated": "2019-08-24T14:15:22Z",
    "3rdPartyId": "string",
    "recievedDatetime": "2019-08-24T14:15:22Z",
    "status": "string",
    "number": "string",
    "revision": "string",
    "title": "string",
    "message": "string",
    "addressees": [ … ]
  }
]

Put RFI Response into a 3rd Party System (e.g. Procore).

Request

Put RFI Response into a 3rd Party system (e.g. Procore). For this to work, the specified 3rd Party system user account must have an active API connection and permissions in the 3rd Party system.

Security
OAuth2 or apiKeyAuth
Bodyapplication/json
brandIdstring(CompactUUID)^[0-9a-fA-F]{32}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
namestring[ 1 .. 64 ] characters

The name given to this Reason Code.

curl -i -X POST \
  https://developers-internal.tonicdm.com/_mock/tonicdm-product/workflow/rfi-integrations \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "brandId": "8e8aa42241794371ae9d0ed7b67a8c86",
    "name": "string"
  }'

Responses

Successfully created the resource you sent

Bodyapplication/json
idstring(CompactUUID)^[0-9a-fA-F]{32}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
datetimeCreatedstring(date-time)read-only

The date and time this record was created.

datetimeUpdatedstring(date-time)read-only

The date and time this record was last updated.

brandIdstring(CompactUUID)^[0-9a-fA-F]{32}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
namestring[ 1 .. 64 ] characters

The name given to this Reason Code.

Response
application/json
{
  "id": "8e8aa42241794371ae9d0ed7b67a8c86",
  "datetimeCreated": "2019-08-24T14:15:22Z",
  "datetimeUpdated": "2019-08-24T14:15:22Z",
  "brandId": "8e8aa42241794371ae9d0ed7b67a8c86",
  "name": "string"
}

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