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

Get Notes

Request

Retreive the notes associated with an item

Query

searchQuerystring(JSON)

A JSON-encoded string containing the query options.

Example: searchQuery={"example"}

filterIdsArray of strings(CompactUUID)

Returns data for the specified GUIDs

Example: filterIds={id},{id},{id}

filterStatusesArray of strings(Status)

Provide the values of one or more statuses separated by comma (no spaces). If no value is supplied, active is assumed.

Items Enum"active""inactive""deleted"

Example: filterStatuses=active,inactive

dataQuantityboolean

If caching data on the client side, the data_quantity=id_only|basic|complete option can be passed to manage the completeness of the data received and therefore rate limiting.

Default false

Example: dataQuantity=true

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

sortBystring

The field by which to sort the results

Enum"personName""actionDateTime"

sortDirectionstring

The sort direction for the results

Enum"asc""desc"

curl -i -X GET \
  'https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/notes?dataQuantity=true&filterIds={id}%2C{id}%2C{id}&filterStatuses=active%2Cinactive&pageNumber=1&pageSize=100&searchQuery={%22example%22}&sortBy=personName&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.

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 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
  }
]

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

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

TonicDM Product API (0.0.5)

Organizations & People

Projects & Teams

Notes

Get Notes

Request

Responses

Was this helpful?

New Note

Request

Responses

Was this helpful?

Edit Note

Request

Responses

Was this helpful?

Disciplines & Certification Definitions

Filesets

Manual Uploading

Cloud File Systems

Correspondence

File Transfers

RFIs

Submittals

PCOs

COs

Tasks