Skip to content
Submittals
/
Delete Submittal

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

Submittals

APIs to the Submittals Workflow module.

Operations

Change an Submittal

Request

Change an Submittal.

Security
OAuth2 or apiKeyAuth
Bodyapplication/json
idstring(CompactUUID)^[0-9a-fA-F]{32}$required
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
our_response_requiredboolean
Default true
our_specsectionstring
statusstring(Status)

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

Default "active"
Enum"active""inactive""deleted"
project_idstring(CompactUUID)^[0-9a-fA-F]{32}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
item_disciplineobject(DisciplineWithId)

The list of disciplines in TonicDM.

stagestring
manual_stageboolean
Default false
manual_received_datetimestring(date-time)
manual_response_datetimestring(date-time)
our_response_required_datestring(date)
our_numberstring
our_revisionstring
our_titlestring

The overall title given to this Item, in the manner of the subject of an email. This will typically match the title of the received Part, but not always.

responsible_person_idstring(CompactUUID)^[0-9a-fA-F]{32}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
partsArray of objects(SubmittalPart)
curl -i -X PATCH \
  https://developers-internal.tonicdm.com/_mock/tonicdm-product/workflow/submittals \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "8e8aa42241794371ae9d0ed7b67a8c86",
    "our_response_required": true,
    "our_specsection": "string",
    "status": "active",
    "project_id": "8e8aa42241794371ae9d0ed7b67a8c86",
    "item_discipline": {
      "id": "8e8aa42241794371ae9d0ed7b67a8c86"
    },
    "stage": "string",
    "manual_stage": false,
    "manual_received_datetime": "2019-08-24T14:15:22Z",
    "manual_response_datetime": "2019-08-24T14:15:22Z",
    "our_response_required_date": "2019-08-24",
    "our_number": "string",
    "our_revision": "string",
    "our_title": "string",
    "responsible_person_id": "8e8aa42241794371ae9d0ed7b67a8c86",
    "parts": [
      {
        "part_type": "receive",
        "status": "string",
        "number": "string",
        "revision": "string",
        "title": "string",
        "message": "string",
        "item_id": "8e8aa42241794371ae9d0ed7b67a8c86",
        "action_datetime": "2019-08-24T14:15:22Z",
        "from_organization_id": "8e8aa42241794371ae9d0ed7b67a8c86",
        "response_required_date": "2019-08-24",
        "fileset_zone": "string",
        "fileset_id": "8e8aa42241794371ae9d0ed7b67a8c86",
        "response_required": true,
        "specsection": "string",
        "submittalStamp": "string"
      }
    ]
  }'

Responses

Successfully changed the resource you sent

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

The date and time this Item was created.

datetimeUpdatedstring(date-time)read-only

The date and time this Item was last updated.

statusstring(Status)

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

Default "active"
Enum"active""inactive""deleted"
project_idstring(CompactUUID)^[0-9a-fA-F]{32}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
item_disciplineobject(DisciplineWithId)

The list of disciplines in TonicDM.

workflow_numberintegerread-only
is_internal_forwardbooleanread-only
stagestring
manual_stageboolean
Default false
manual_received_datetimestring(date-time)
manual_response_datetimestring(date-time)
our_response_required_datestring(date)
our_numberstring
our_revisionstring
our_titlestring

The overall title given to this Item, in the manner of the subject of an email. This will typically match the title of the received Part, but not always.

responsible_person_idstring(CompactUUID)^[0-9a-fA-F]{32}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
partsArray of objects(SubmittalPart)
Response
application/json
{
  "id": "8e8aa42241794371ae9d0ed7b67a8c86",
  "our_response_required": true,
  "our_specsection": "string",
  "datetimeCreated": "2019-08-24T14:15:22Z",
  "datetimeUpdated": "2019-08-24T14:15:22Z",
  "status": "active",
  "project_id": "8e8aa42241794371ae9d0ed7b67a8c86",
  "item_discipline": {
    "id": "8e8aa42241794371ae9d0ed7b67a8c86",
    "initials": "string",
    "abbreviation": "string",
    "name": "string"
  },
  "workflow_number": 0,
  "is_internal_forward": true,
  "stage": "string",
  "manual_stage": false,
  "manual_received_datetime": "2019-08-24T14:15:22Z",
  "manual_response_datetime": "2019-08-24T14:15:22Z",
  "our_response_required_date": "2019-08-24",
  "our_number": "string",
  "our_revision": "string",
  "our_title": "string",
  "responsible_person_id": "8e8aa42241794371ae9d0ed7b67a8c86",
  "parts": [
    { … }
  ]
}

Delete Submittal

Request

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

Security
OAuth2 or apiKeyAuth
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/submittals?id=8e8aa42241794371ae9d0ed7b67a8c86' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successfully deleted the resource you requested

Response
No content

Get Submittal Parts

Request

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

Security
OAuth2 or apiKeyAuth
Query
filterIdsArray of strings(CompactUUID)

Returns data for the specified GUIDs. If this filter is specifed, all other filters will be ignored.

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/submittal-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}$
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}$
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}$
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}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
response_requiredboolean
specsectionstring

A code representing the section of the project specification related to this submittal.

submittalStampstring

The text of the selection chosen on the stamp applied to this submittal.

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

PCOs

APIs to the PCOs Workflow module.

Operations

COs

APIs to the COs Workflow module.

Operations

Tasks

APIs to the Tasks Workflow module.

Operations