Notes
/
Edit Note

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

New Note

Request

placeholder value for description

Bodyapplication/jsonrequired
statusstring(Status)

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

Default "active"
Enum"active""inactive""deleted"
contentstring(html)

The HTML content of the Note.

attachedToIdstring(uuid)required

The ID of the TonicDM item the note is attached to.

personIdstring(uuid)required

The GUID of the Person who created the Note.

isPrintedboolean
Default false
curl -i -X POST \
  https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/notes \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "status": "active",
    "content": "string",
    "attachedToId": "13950bd3-cbc8-46f8-9a0d-f72ea7643f38",
    "personId": "f3e5ff26-28ff-4cd6-9b1b-e303a185a13a",
    "isPrinted": false
  }'

Responses

Successfully created the resource you sent

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

UUID without hyphens (32 characters)

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

The date and time this Note was created.

datetimeUpdatedstring(date-time)read-only

The date and time this Note 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"
contentstring(html)

The HTML content of the Note.

attachedToIdstring(uuid)required

The ID of the TonicDM item the note is attached to.

personIdstring(uuid)required

The GUID of the Person who created the Note.

isPrintedboolean
Default false
Response
application/json
{
  "id": "8e8aa42241794371ae9d0ed7b67a8c86",
  "datetimeCreated": "2019-08-24T14:15:22Z",
  "datetimeUpdated": "2019-08-24T14:15:22Z",
  "status": "active",
  "content": "string",
  "attachedToId": "13950bd3-cbc8-46f8-9a0d-f72ea7643f38",
  "personId": "f3e5ff26-28ff-4cd6-9b1b-e303a185a13a",
  "isPrinted": false
}

Edit Note

Request

Make changes to an existing Note.

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

UUID without hyphens (32 characters)

Example: "8e8aa42241794371ae9d0ed7b67a8c86"
statusstring(Status)

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

Default "active"
Enum"active""inactive""deleted"
contentstring(html)

The HTML content of the Note.

attachedToIdstring(uuid)required

The ID of the TonicDM item the note is attached to.

personIdstring(uuid)required

The GUID of the Person who created the Note.

isPrintedboolean
Default false
curl -i -X PATCH \
  https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/notes \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "8e8aa42241794371ae9d0ed7b67a8c86",
    "status": "active",
    "content": "string",
    "attachedToId": "13950bd3-cbc8-46f8-9a0d-f72ea7643f38",
    "personId": "f3e5ff26-28ff-4cd6-9b1b-e303a185a13a",
    "isPrinted": false
  }'

Responses

Successfully updated the resource you sent

Response
No content

Delete Notes

Request

placeholder value for description

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/core/notes?id=8e8aa42241794371ae9d0ed7b67a8c86' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successfully deleted the resource you requested

Response
No content

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

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