Disciplines & Certification Definitions
/
Edit Certification Definition

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

Disciplines & Certification Definitions

Disciplines & Certification Definitions recognize areas of professional expertise.

Operations

New Certification Definition

Request

placeholder value for description

Bodyapplication/jsonrequired
appliesTostring

The type of record this Certification definition applies to.

Enum"organization""project""person"
statusstring(Status)

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

Default "active"
Enum"active""inactive""deleted"
namestring[ 1 .. 40 ] charactersrequired

The name of the certification definition.

jurisdictionstring[ 0 .. 20 ] charactersrequired

The geographic region in which the certification definition applies.

curl -i -X POST \
  https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/certification-definitions \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "status": "active",
    "appliesTo": "project",
    "name": "LEED Platinum",
    "jurisdiction": "US"
  }'

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 Certification definition was created.

datetimeUpdatedstring(date-time)read-only

The date and time this Certification definition was last updated.

appliesTostring

The type of record this Certification definition applies to.

Enum"organization""project""person"
statusstring(Status)

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

Default "active"
Enum"active""inactive""deleted"
namestring[ 1 .. 40 ] charactersrequired

The name of the certification definition.

jurisdictionstring[ 0 .. 20 ] charactersrequired

The geographic region in which the certification definition applies.

Response
application/json
{
  "id": "2d407c21dcf748d1b437f51f966bfd5c",
  "datetimeCreated": "2021-11-03T16:21:02+00:00",
  "datetimeUpdated": "2024-04-20T16:21:02+00:00",
  "status": "active",
  "appliesTo": "project",
  "name": "LEED Platinum",
  "jurisdiction": "US"
}

Edit Certification Definition

Request

Make changes to an existing Certification Definition.

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

UUID without hyphens (32 characters)

Example: "8e8aa42241794371ae9d0ed7b67a8c86"
appliesTostring

The type of record this Certification definition applies to.

Enum"organization""project""person"
statusstring(Status)

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

Default "active"
Enum"active""inactive""deleted"
namestring[ 1 .. 40 ] charactersrequired

The name of the certification definition.

jurisdictionstring[ 0 .. 20 ] charactersrequired

The geographic region in which the certification definition applies.

curl -i -X PATCH \
  https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/certification-definitions \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "2d407c21dcf748d1b437f51f966bfd5c",
    "status": "active",
    "appliesTo": "project",
    "name": "LEED Platinum",
    "jurisdiction": "US"
  }'

Responses

Successfully read the resource you requested. One or more records are returned in the form of an array.

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 Certification definition was created.

datetimeUpdatedstring(date-time)read-only

The date and time this Certification definition was last updated.

appliesTostring

The type of record this Certification definition applies to.

Enum"organization""project""person"
statusstring(Status)

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

Default "active"
Enum"active""inactive""deleted"
namestring[ 1 .. 40 ] charactersrequired

The name of the certification definition.

jurisdictionstring[ 0 .. 20 ] charactersrequired

The geographic region in which the certification definition applies.

Response
application/json
{
  "id": "2d407c21dcf748d1b437f51f966bfd5c",
  "datetimeCreated": "2021-11-03T16:21:02+00:00",
  "datetimeUpdated": "2024-04-20T16:21:02+00:00",
  "status": "active",
  "appliesTo": "project",
  "name": "LEED Platinum",
  "jurisdiction": "US"
}

Delete Certification Definitions

Request

placeholder value for description

curl -i -X DELETE \
  https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/certification-definitions \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successfully deleted the resource you requested

Response
No content

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