Skip to content
Labels
/
Retreive Labels

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

Teams

The list of People associated with a Project.

Operations

Groups

The list of Groups associated with a Project.

Operations

Labels

Operations relating to the Labels that can be attached to various objects.

Operations

Retreive Labels

Request

Retreive the labels associated with one or more objects provided in the filterIds parameter. To return only active Labels, pass active in the filterStatuses parameter.

Data will be returned as an array of each object uuid provided in the filterIds parameter, along with the list of labelIds that are assigned to it.

Security
OAuth2 or apiKeyAuth
Query
searchQuerystring(JSON)

A JSON-encoded string containing the query options.

Example: searchQuery={"example"}
filterIdsArray of strings(CompactUUID)

Returns data for the specified GUIDs. If this filter is specifed, all other filters will be ignored.

Example: filterIds={id},{id},{id}
filterStatusesArray of strings(Status)

Provide the values of one or more statuses separated by comma (no spaces). If more than one filter is given, they will be combined with AND. If no value is supplied, active is assumed.

Items Enum"active""inactive""deleted"
Example: filterStatuses=active,inactive
filterObjectTypestring

Provide a single Object Type.

Value"person"
Example: filterObjectType=person
dataQuantitystring

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 "id_only"
Enum"id_only""basic""complete"
Example: dataQuantity=id_only
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
sortDirectionstring

The sort direction for the results

Enum"asc""desc"
curl -i -X GET \
  'https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/labels?searchQuery={%22example%22}&filterIds={id}%2C{id}%2C{id}&filterStatuses=active%2Cinactive&filterObjectType=person&dataQuantity=id_only&pageSize=100&pageNumber=1&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}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
datetimeCreatedstring(date-time)read-only

The date and time this label was created.

datetimeUpdatedstring(date-time)read-only

The date and time this label 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"
titlestring[ 1 .. 16 ] charactersrequired

The plaintext title of the label.

colorstring(uuid)required

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

ownersArray of objects
shareTypestring

Defines what users other than the Primary Owner can do with the label.

  • view allows seeing the label and the list of objects associated with it.
  • associate allows seeing the label and adding or removing objects from being associated with it.
  • full allows editing the title, color and shareType of the label and adding or removing objects from being associated with it.
Default "associate"
Enum"view""associate""full"
]
Response
application/json
[
  {
    "id": "8e8aa42241794371ae9d0ed7b67a8c86",
    "datetimeCreated": "2019-08-24T14:15:22Z",
    "datetimeUpdated": "2019-08-24T14:15:22Z",
    "status": "active",
    "title": "string",
    "color": "46ec562d-25e7-434f-b82d-7b8da35e03fb",
    "owners": [ … ],
    "shareType": "view"
  }
]

New Label

Request

placeholder value for description

Security
OAuth2 or apiKeyAuth
Bodyapplication/json
statusstring(Status)

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

Default "active"
Enum"active""inactive""deleted"
titlestring[ 1 .. 16 ] charactersrequired

The plaintext title of the label.

colorstring(uuid)required

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

ownersArray of objects
shareTypestring

Defines what users other than the Primary Owner can do with the label.

  • view allows seeing the label and the list of objects associated with it.
  • associate allows seeing the label and adding or removing objects from being associated with it.
  • full allows editing the title, color and shareType of the label and adding or removing objects from being associated with it.
Default "associate"
Enum"view""associate""full"
curl -i -X POST \
  https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/labels \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "status": "active",
    "title": "string",
    "color": "46ec562d-25e7-434f-b82d-7b8da35e03fb",
    "owners": [
      {
        "personId": "8e8aa42241794371ae9d0ed7b67a8c86",
        "isPrimaryOwner": false
      }
    ],
    "shareType": "view"
  }'

Responses

Successfully created the resource you sent

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

The date and time this label was created.

datetimeUpdatedstring(date-time)read-only

The date and time this label 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"
titlestring[ 1 .. 16 ] charactersrequired

The plaintext title of the label.

colorstring(uuid)required

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

ownersArray of objects
shareTypestring

Defines what users other than the Primary Owner can do with the label.

  • view allows seeing the label and the list of objects associated with it.
  • associate allows seeing the label and adding or removing objects from being associated with it.
  • full allows editing the title, color and shareType of the label and adding or removing objects from being associated with it.
Default "associate"
Enum"view""associate""full"
Response
application/json
{
  "id": "8e8aa42241794371ae9d0ed7b67a8c86",
  "datetimeCreated": "2019-08-24T14:15:22Z",
  "datetimeUpdated": "2019-08-24T14:15:22Z",
  "status": "active",
  "title": "string",
  "color": "46ec562d-25e7-434f-b82d-7b8da35e03fb",
  "owners": [
    { … }
  ],
  "shareType": "view"
}

Edit Label

Request

Make changes to an existing Label.

Security
OAuth2 or apiKeyAuth
Bodyapplication/json
idstring(CompactUUID)^[0-9a-fA-F]{32}$
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"
titlestring[ 1 .. 16 ] charactersrequired

The plaintext title of the label.

colorstring(uuid)required

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

ownersArray of objects
shareTypestring

Defines what users other than the Primary Owner can do with the label.

  • view allows seeing the label and the list of objects associated with it.
  • associate allows seeing the label and adding or removing objects from being associated with it.
  • full allows editing the title, color and shareType of the label and adding or removing objects from being associated with it.
Default "associate"
Enum"view""associate""full"
curl -i -X PATCH \
  https://developers-internal.tonicdm.com/_mock/tonicdm-product/core/labels \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "8e8aa42241794371ae9d0ed7b67a8c86",
    "status": "active",
    "title": "string",
    "color": "46ec562d-25e7-434f-b82d-7b8da35e03fb",
    "owners": [
      {
        "personId": "8e8aa42241794371ae9d0ed7b67a8c86",
        "isPrimaryOwner": false
      }
    ],
    "shareType": "view"
  }'

Responses

Successfully updated the resource you sent

Response
No content

Notes

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

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