Skip to content

New Project

Request

Create a new Project for the User's Organization.

Security
OAuth2(Required scopes: readwrite)
Bodyapplication/json
Array [
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
projectNumberstring, [ 1 .. 64 ] charactersrequired

Project Reference Number

projectNameLegalstring, [ 1 .. 256 ] charactersrequired

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

projectNameKnownAsstring, [ 0 .. 256 ] characters

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

projectSearchWordsstring, [ 0 .. 256 ] characters

NOT YET IMPLEMENTED.

Text to assist staff when searching for the project (can be used for previously used project numbers or names, or other keywords that might be used to find the project)

projectManagerobject(Person)

NOT YET IMPLEMENTED.

Requires the TonicDM AdvancedMetrics license.

Refer to the dataQuantity Request parameter to understand the level of detail returned.

projectPrincipalobject(Person)

NOT YET IMPLEMENTED.

REQUIRES the TonicDM AdvancedMetrics license.

Refer to the dataQuantity Request parameter to understand the level of detail returned.

brandobject(Brand)

NOT YET IMPLEMENTED AT THE TENANT LEVEL.

REQUIRES the TonicDM AdvancedContacts license.

Refer to the dataQuantity Request parameter to understand the level of detail returned.

locationIdstring(CompactUUID)^[0-9a-fA-F]{32}$write-only

The UUID of the Location record.

Example:"8e8aa42241794371ae9d0ed7b67a8c86"
division1object(Division)

NOT YET IMPLEMENTED.

REQUIRES the TonicDM AdvancedMetrics license.

Refer to the dataQuantity Request parameter to understand the level of detail returned.

division2object(Division)

NOT YET IMPLEMENTED.

REQUIRES the TonicDM AdvancedMetrics license.

Refer to the dataQuantity Request parameter to understand the level of detail returned.

division3object(Division)

NOT YET IMPLEMENTED.

REQUIRES the TonicDM AdvancedMetrics license.

Refer to the dataQuantity Request parameter to understand the level of detail returned.

division4object(Division)

NOT YET IMPLEMENTED.

REQUIRES the TonicDM AdvancedMetrics license.

Refer to the dataQuantity Request parameter to understand the level of detail returned.

certificationsArray of objects(Certification)

NOT YET IMPLEMENTED.

REQUIRES the TonicDM AdvancedContacts license.

Refer to the dataQuantity Request parameter to understand the level of detail returned.

The UUIDs of zero or more certifications that this Project has obtained, or intends to obtain.

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

NOT YET IMPLEMENTED.

Refer to the dataQuantity Request parameter to understand the level of detail returned.

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

clientProjectNumberstring, [ 0 .. 32 ] characters

NOT YET IMPLEMENTED.

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

customerDataWarehouseIdstring

The ID of the Person in the Customer's Data Warehouse.

FOR USE BY CUSTOMER. NOT YET IMPLEMENTED. REQUIRES the TonicDM AdvancedMetrics license.

customerErpIdstring

The ID of the Person in the Customer's ERP system (eg. Deltek Vantagepoint).

FOR USE BY CUSTOMER. NOT YET IMPLEMENTED. REQUIRES the TonicDM AdvancedMetrics license.

customerCrmIdstring

The ID of the Person in the Customer's CRM system (eg. Deltek Salesforce).

FOR USE BY CUSTOMER. NOT YET IMPLEMENTED. REQUIRES the TonicDM AdvancedMetrics license.

programobject(Program)

NOT YET IMPLEMENTED.

REQUIRES the TonicDM AdvancedProjects license.

Refer to the dataQuantity Request parameter to understand the level of detail returned.

relatedProjectsArray of objects(Project)

NOT YET IMPLEMENTED.

Refer to the dataQuantity Request parameter to understand the level of detail returned.

The UUIDs of zero or more TonicDM projects that this Project is notionally related to.

Refer to the help page for 'Related Projects'.

]
curl -i -X POST \
  https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/projects/insert \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "status": "active",
    "isLocked": true,
    "projectNumber": "20-032",
    "projectNameLegal": "Olympic Rugby Venue",
    "projectNameKnownAs": "Paris Stadium",
    "location": "6ce635890a6349678196d2e59a3be302"
  }'

Responses

Successfully created the resource you sent

Bodyapplication/json
statusstringrequired
Value:"success"
dataArray of objects, = 1 items(Project)required
metadataobject(ResponseMetadata)required

Present on every JSON response. For non-paginated operations, page will be 1, total_pages will be 1, and total_records equal to the number of elements in data.

Response
{
  "status": "success",
  "data": [
    { … }
  ],
  "metadata": {
    "timestamp": "2024-11-04T10:30:00Z",
    "correlation_id": "abc-123",
    "page": 1,
    "total_pages": 1,
    "total_records": 1
  }
}