Get RFI Parts

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

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

RFIs

APIs to the RFIs Workflow module.

Operations

Delete RFI

Request

Note that deleting an RFI will fail if it has been forwarded or returned.

Query

idstring(CompactUUID)^[0-9a-fA-F]{32}$required

ID of the resource to delete.

Example: id=8e8aa42241794371ae9d0ed7b67a8c86

curl -i -X DELETE \
  'https://developers-internal.tonicdm.com/_mock/tonicdm-product/workflow/rfis?id=8e8aa42241794371ae9d0ed7b67a8c86' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successfully deleted the resource you requested

Response

No content

Get RFI Parts

Request

Get the details of Parts of RFIs stored in the Workflow module, either by specifying one or more RFI Items to get all the Parts for those RFIs, or by specifying the GUIDs of the Parts themselves. Parts are the actions that have occured for an Item, eg. when the Item was received, when it was forwarded etc.

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/rfi-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"

datetimeCreatedstring(date-time)read-only

The date and time this Part was created.

datetimeUpdatedstring(date-time)read-only

The date and time this Part was last updated.

part_typestring

An Item Part represents a transaction, which can be one of four functional types.

Enum"receive""forward""return_of_forward""response"

sourcestringread-only

Indicates whether this Part was created with user-supplied information or whether it was created automatically by TonicDM (as the delivery of an item sent through TonicDM). Only user Parts can be edited.

Enum"user""system"

statusstring

numberstring

The 'identifying code' given to this transaction, typically a number.

revisionstring

The revision number of the 'identifying code' given to this transaction,

titlestring

The title given to this transaction, in the manner of the subject of an email.

messagestring

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

item_idstring(CompactUUID)^[0-9a-fA-F]{32}$

UUID without hyphens (32 characters)

Example: "8e8aa42241794371ae9d0ed7b67a8c86"

workflow_numberintegerread-only

The Workflow that this Part belongs to. Note that this is redundant with the Workflow assigned at the Item level.

action_datetimestring(date-time)

The recorded datetime that the transaction represented by this Part took place. It may be different from the datetimeCreated when the transaction is manually entered.

from_organization_idstring(CompactUUID)^[0-9a-fA-F]{32}$

UUID without hyphens (32 characters)

Example: "8e8aa42241794371ae9d0ed7b67a8c86"

response_required_datestring(date)

The date when a response to this transaction is required by.

fileset_zonestring

The TonicDM zone where the files are stored.

fileset_idstring(CompactUUID)^[0-9a-fA-F]{32}$

UUID without hyphens (32 characters)

Example: "8e8aa42241794371ae9d0ed7b67a8c86"

]

Response

application/json

[
  {
    "id": "be26af2278974fddb5fcf67d83c10de4"
  },
  {
    "id": "be26af2278974fddb5fcf67d83c10de3"
  }
]

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.

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?pageNumber=1&pageSize=100&platform=egnyte&searchQuery={%22example%22}&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"
  }
]

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

TonicDM Product API (0.0.5)

Organizations & People

Projects & Teams

Notes

Disciplines & Certification Definitions

Filesets

Manual Uploading

Cloud File Systems

Correspondence

File Transfers

RFIs

Delete RFI

Request

Responses

Was this helpful?

Get RFI Parts

Request

Responses

Was this helpful?

Pull an RFI List from a 3rd party system.

Request

Responses

Was this helpful?

Submittals

PCOs

COs

Tasks