Projects
/
Merge Projects

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

Edit Project

Request

Make changes to the Project record.

Bodyapplication/json
idstring(CompactUUID)^[0-9a-fA-F]{32}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
systemAccessstring

Puts the project into a status of readOnly (data can be read but not written) or noAccess (data cannot be read or written). These states can only be set by the system and are used when project data is being migrated between Zones (data centers) or for other administrative purposes.

Default "readWrite"
Enum"readWrite""readOnly""noAccess"
statusstring(Status)

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

Default "active"
Enum"active""inactive""deleted"
zonestring

The name of the Zone (data center) the Project data is stored in.

purposestring

Projects are used for different purposes in the TonicDM system.

Default "billable"
Enum"billable""opportunity""overhead""training"
isLockedboolean

Restricts access to the project to active team members. This field can only be set by one of the Tenant Adminstrators.

Default false
projectNumberstringrequired

Project Reference Number

projectNameLegalstring[ 1 .. 128 ] charactersrequired

The full official name of the Project (used on Transmittals).

projectNameKnownAsstring[ 0 .. 16 ] characters

A friendly name for the Project (used in the TonicDM app)

projectSearchWordsstring[ 0 .. 256 ] characters

Text to assist staff when searching for the project (typically previously used project numbers or names)

projectManagerIdstring^[0-9a-fA-F]{32}$

Use of this feature requires the TonicDM AdvancedMetrics license.

Example: "8e8aa42241794371ae9d0ed7b67a8c86"
projectPrincipalIdstring^[0-9a-fA-F]{32}$

Use of this feature requires the TonicDM AdvancedMetrics license.

Example: "8e8aa42241794371ae9d0ed7b67a8c86"
brandIdstring(CompactUUID)^[0-9a-fA-F]{32}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
officeIdstring(CompactUUID)^[0-9a-fA-F]{32}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
division1Idstring(CompactUUID)^[0-9a-fA-F]{32}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
division2Idstring(CompactUUID)^[0-9a-fA-F]{32}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
division3Idstring(CompactUUID)^[0-9a-fA-F]{32}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
division4Idstring(CompactUUID)^[0-9a-fA-F]{32}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
certificationsArray of strings(CompactUUID)

Zero or more certifications that this Project has obtained, or intends to obtain. Use of this feature requires the TonicDM AdvancedContacts license.

Example: ["8e8aa42241794371ae9d0ed7b67a8c86"]
caUseSequenceNumbersRfistring

Whether the RFIs should default to the senders number or use a unique sequential number. This is done as an enum in case there are other options added in the future, such as pattern.

Default "sender"
Enum"sender""sequential"
caOurRfiDaysinteger

The default number of days we have to return RFIs back to the organization we received them from

caOurSubmittalDaysinteger

The default number of days we have to return Submittals back to the organization we received them from

caRecipientRfiDaysinteger

When we forward RFIs, the default number of days recipients have to return them to us

caRecipientSubmittalDaysinteger

When we forward Submittals, the default number of days recipients have to return them to us

clientOrganizationIdstring(guid)^[0-9a-fA-F]{32}$

The OrganizationId of the project's client (so their name can appear on the Transmittal).

clientProjectNumberstring[ 0 .. 32 ] characters

The project reference number of the project's client (for use on the Transmittal).

customerDataWarehouseIdstring[ 0 .. 40 ] characters

The id of the project in the customer's data warehouse.

customerErpIdstring[ 0 .. 40 ] characters

The id of the project in the customer's ERP or accounting system.

customerCrmIdstring[ 0 .. 40 ] characters

The id of the project in the customer's CRM system.

curl -i -X PATCH \
  https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/projects \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "d6935bb577244d1692fe544c9c8ae6bd",
    "status": "inactive",
    "zone": "aws-us",
    "isLocked": false,
    "projectNumber": "17-005",
    "projectNameLegal": "Es Todo Cafe and Grill",
    "projectNameKnownAs": "Es Todo",
    "officeIdId": "eec6b047435d492e9540a3496b5e5fe9",
    "division1Id": null,
    "certifications": null,
    "customerDataWarehouseId": "5FE10194613346058C073BA456947556",
    "customerErpId": "ae656d88-c979-4e11-ba0b-695b61fa7f5d",
    "customerCrmId": "9a6d37ef-fc9d-43ee-ac78-678c273cc1e8"
  }'

Responses

Successfully updated the resource you requested

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

The date and time this Project was created.

datetimeUpdatedstring(date-time)read-only

The date and time this Project was last updated.

systemAccessstring

Puts the project into a status of readOnly (data can be read but not written) or noAccess (data cannot be read or written). These states can only be set by the system and are used when project data is being migrated between Zones (data centers) or for other administrative purposes.

Default "readWrite"
Enum"readWrite""readOnly""noAccess"
statusstring(Status)

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

Default "active"
Enum"active""inactive""deleted"
zonestring

The name of the Zone (data center) the Project data is stored in.

purposestring

Projects are used for different purposes in the TonicDM system.

Default "billable"
Enum"billable""opportunity""overhead""training"
isLockedboolean

Restricts access to the project to active team members. This field can only be set by one of the Tenant Adminstrators.

Default false
projectNumberstringrequired

Project Reference Number

projectNameLegalstring[ 1 .. 128 ] charactersrequired

The full official name of the Project (used on Transmittals).

projectNameKnownAsstring[ 0 .. 16 ] characters

A friendly name for the Project (used in the TonicDM app)

projectSearchWordsstring[ 0 .. 256 ] characters

Text to assist staff when searching for the project (typically previously used project numbers or names)

projectManagerIdstring^[0-9a-fA-F]{32}$

Use of this feature requires the TonicDM AdvancedMetrics license.

Example: "8e8aa42241794371ae9d0ed7b67a8c86"
projectPrincipalIdstring^[0-9a-fA-F]{32}$

Use of this feature requires the TonicDM AdvancedMetrics license.

Example: "8e8aa42241794371ae9d0ed7b67a8c86"
brandIdstring(CompactUUID)^[0-9a-fA-F]{32}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
officeIdstring(CompactUUID)^[0-9a-fA-F]{32}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
division1Idstring(CompactUUID)^[0-9a-fA-F]{32}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
division2Idstring(CompactUUID)^[0-9a-fA-F]{32}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
division3Idstring(CompactUUID)^[0-9a-fA-F]{32}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
division4Idstring(CompactUUID)^[0-9a-fA-F]{32}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
certificationsArray of strings(CompactUUID)

Zero or more certifications that this Project has obtained, or intends to obtain. Use of this feature requires the TonicDM AdvancedContacts license.

Example: ["8e8aa42241794371ae9d0ed7b67a8c86"]
caUseSequenceNumbersRfistring

Whether the RFIs should default to the senders number or use a unique sequential number. This is done as an enum in case there are other options added in the future, such as pattern.

Default "sender"
Enum"sender""sequential"
caOurRfiDaysinteger

The default number of days we have to return RFIs back to the organization we received them from

caOurSubmittalDaysinteger

The default number of days we have to return Submittals back to the organization we received them from

caRecipientRfiDaysinteger

When we forward RFIs, the default number of days recipients have to return them to us

caRecipientSubmittalDaysinteger

When we forward Submittals, the default number of days recipients have to return them to us

clientOrganizationIdstring(guid)^[0-9a-fA-F]{32}$

The OrganizationId of the project's client (so their name can appear on the Transmittal).

clientProjectNumberstring[ 0 .. 32 ] characters

The project reference number of the project's client (for use on the Transmittal).

customerDataWarehouseIdstring[ 0 .. 40 ] characters

The id of the project in the customer's data warehouse.

customerErpIdstring[ 0 .. 40 ] characters

The id of the project in the customer's ERP or accounting system.

customerCrmIdstring[ 0 .. 40 ] characters

The id of the project in the customer's CRM system.

Response
application/json
{
  "id": "d6935bb577244d1692fe544c9c8ae6bd",
  "datetimeCreated": "2021-11-03T16:21:02+00:01",
  "datetimeUpdated": "2024-04-20T16:21:02+00:01",
  "status": "inactive",
  "zone": "aws-us",
  "isLocked": false,
  "projectNumber": "17-005",
  "projectNameLegal": "Es Todo Cafe and Grill",
  "projectNameKnownAs": "Es Todo",
  "officeId": "eec6b047435d492e9540a3496b5e5fe9",
  "division1Id": null,
  "certifications": null,
  "customerDataWarehouseId": "5FE10194613346058C073BA456947556",
  "customerErpId": "ae656d88-c979-4e11-ba0b-695b61fa7f5d",
  "customerCrmId": "9a6d37ef-fc9d-43ee-ac78-678c273cc1e8"
}

Merge Projects

Request

Merges Project 1 (source) into Project 2 (target) such that Project 2 remains (and includes the contents of Project 1). The operation can only be performed by one of your organization's TonicDM Administrators.

Query
sourcestring(guid)^[0-9a-fA-F]{32}$required

The project whose data will be moved. This project will be deleted.

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

The project which will receive the data. This project will be kept.

Example: target=?source=7d440aef903b49a0a7544ad3caa8e52f&target=4d5cddd5f65f4016bb66eeecb9b6e446
curl -i -X GET \
  'https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/projects/merge?source=string&target=%3Fsource%3D7d440aef903b49a0a7544ad3caa8e52f%26target%3D4d5cddd5f65f4016bb66eeecb9b6e446' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successfully merged the projects

Response
No content

Teams

The list of People associated with a Project.

Operations

Groups

The list of Groups associated with a Prject.

Operations

Notes

Operations relating to the Notes that can be attached to various items.

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

PCOs

APIs to the PCOs Workflow module.

Operations

COs

APIs to the COs Workflow module.

Operations

Tasks

APIs to the Tasks Workflow module.

Operations