Tasks

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

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

Get Tasks

Request

Get Tasks stored in the Workflow module.

Query
filterIdsArray of strings(CompactUUID)

Returns data for the specified GUIDs

Example: filterIds={id},{id},{id}
curl -i -X GET \
  'https://developers-internal.tonicdm.com/_mock/tonicdm-product/workflow/tasks?filterIds={id}%2C{id}%2C{id}' \
  -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 Item was created.

datetimeUpdatedstring(date-time)read-only

The date and time this Item 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"
project_idstring(CompactUUID)^[0-9a-fA-F]{32}$

UUID without hyphens (32 characters)

Example: "8e8aa42241794371ae9d0ed7b67a8c86"
item_disciplineobject(DisciplineWithId)

Defines the list of disciplines in TonicDM, and also defines whether that discipline initiates and/or receives each workflow type.

workflow_numberintegerread-only
is_internal_forwardbooleanread-only
stagestring
manual_stageboolean
Default false
manual_received_datetimestring(date-time)
manual_response_datetimestring(date-time)
our_response_required_datestring(date)
our_numberstring
our_revisionstring
our_titlestring

The overall title given to this Item, in the manner of the subject of an email. This will typically match the title of the received Part, but not always.

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

UUID without hyphens (32 characters)

Example: "8e8aa42241794371ae9d0ed7b67a8c86"
partsArray of objects(TaskPart)
]
Response
application/json
[
  {
    "id": "be26af2278974fddb5fcf67d83c10de4"
  },
  {
    "id": "be26af2278974fddb5fcf67d83c10de3"
  }
]

Create Task

Request

Create an Task in the Workflow module of a particular Project.

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"
project_idstring(CompactUUID)^[0-9a-fA-F]{32}$required

UUID without hyphens (32 characters)

Example: "8e8aa42241794371ae9d0ed7b67a8c86"
item_disciplineobject(DisciplineWithId)

Defines the list of disciplines in TonicDM, and also defines whether that discipline initiates and/or receives each workflow type.

stagestring
manual_stageboolean
Default false
manual_received_datetimestring(date-time)
manual_response_datetimestring(date-time)
our_response_required_datestring(date)
our_numberstringrequired
our_revisionstring
our_titlestring

The overall title given to this Item, in the manner of the subject of an email. This will typically match the title of the received Part, but not always.

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

UUID without hyphens (32 characters)

Example: "8e8aa42241794371ae9d0ed7b67a8c86"
partsArray of objects(TaskPart)
curl -i -X POST \
  https://developers-internal.tonicdm.com/_mock/tonicdm-product/workflow/tasks \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "status": "active",
    "project_id": "8e8aa42241794371ae9d0ed7b67a8c86",
    "item_discipline": {
      "id": "string"
    },
    "stage": "string",
    "manual_stage": false,
    "manual_received_datetime": "2019-08-24T14:15:22Z",
    "manual_response_datetime": "2019-08-24T14:15:22Z",
    "our_response_required_date": "2019-08-24",
    "our_number": "string",
    "our_revision": "string",
    "our_title": "string",
    "responsible_person_id": "8e8aa42241794371ae9d0ed7b67a8c86",
    "parts": [
      {
        "part_type": "receive",
        "status": "string",
        "number": "string",
        "revision": "string",
        "title": "string",
        "message": "string",
        "item_id": "8e8aa42241794371ae9d0ed7b67a8c86",
        "action_datetime": "2019-08-24T14:15:22Z",
        "from_organization_id": "8e8aa42241794371ae9d0ed7b67a8c86",
        "response_required_date": "2019-08-24",
        "fileset_zone": "string",
        "fileset_id": "8e8aa42241794371ae9d0ed7b67a8c86"
      }
    ]
  }'

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 Item was created.

datetimeUpdatedstring(date-time)read-only

The date and time this Item 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"
project_idstring(CompactUUID)^[0-9a-fA-F]{32}$

UUID without hyphens (32 characters)

Example: "8e8aa42241794371ae9d0ed7b67a8c86"
item_disciplineobject(DisciplineWithId)

Defines the list of disciplines in TonicDM, and also defines whether that discipline initiates and/or receives each workflow type.

workflow_numberintegerread-only
is_internal_forwardbooleanread-only
stagestring
manual_stageboolean
Default false
manual_received_datetimestring(date-time)
manual_response_datetimestring(date-time)
our_response_required_datestring(date)
our_numberstring
our_revisionstring
our_titlestring

The overall title given to this Item, in the manner of the subject of an email. This will typically match the title of the received Part, but not always.

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

UUID without hyphens (32 characters)

Example: "8e8aa42241794371ae9d0ed7b67a8c86"
partsArray of objects(TaskPart)
Response
application/json
{
  "id": "8e8aa42241794371ae9d0ed7b67a8c86",
  "datetimeCreated": "2019-08-24T14:15:22Z",
  "datetimeUpdated": "2019-08-24T14:15:22Z",
  "status": "active",
  "project_id": "8e8aa42241794371ae9d0ed7b67a8c86",
  "item_discipline": {
    "id": "string",
    "nameInitials": "string",
    "nameShort": "string",
    "nameLong": "string"
  },
  "workflow_number": 0,
  "is_internal_forward": true,
  "stage": "string",
  "manual_stage": false,
  "manual_received_datetime": "2019-08-24T14:15:22Z",
  "manual_response_datetime": "2019-08-24T14:15:22Z",
  "our_response_required_date": "2019-08-24",
  "our_number": "string",
  "our_revision": "string",
  "our_title": "string",
  "responsible_person_id": "8e8aa42241794371ae9d0ed7b67a8c86",
  "parts": [
    { … }
  ]
}

Change an Task

Request

Change an Task.

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

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"
project_idstring(CompactUUID)^[0-9a-fA-F]{32}$

UUID without hyphens (32 characters)

Example: "8e8aa42241794371ae9d0ed7b67a8c86"
item_disciplineobject(DisciplineWithId)

Defines the list of disciplines in TonicDM, and also defines whether that discipline initiates and/or receives each workflow type.

stagestring
manual_stageboolean
Default false
manual_received_datetimestring(date-time)
manual_response_datetimestring(date-time)
our_response_required_datestring(date)
our_numberstring
our_revisionstring
our_titlestring

The overall title given to this Item, in the manner of the subject of an email. This will typically match the title of the received Part, but not always.

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

UUID without hyphens (32 characters)

Example: "8e8aa42241794371ae9d0ed7b67a8c86"
partsArray of objects(TaskPart)
curl -i -X PATCH \
  https://developers-internal.tonicdm.com/_mock/tonicdm-product/workflow/tasks \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "8e8aa42241794371ae9d0ed7b67a8c86",
    "status": "active",
    "project_id": "8e8aa42241794371ae9d0ed7b67a8c86",
    "item_discipline": {
      "id": "string"
    },
    "stage": "string",
    "manual_stage": false,
    "manual_received_datetime": "2019-08-24T14:15:22Z",
    "manual_response_datetime": "2019-08-24T14:15:22Z",
    "our_response_required_date": "2019-08-24",
    "our_number": "string",
    "our_revision": "string",
    "our_title": "string",
    "responsible_person_id": "8e8aa42241794371ae9d0ed7b67a8c86",
    "parts": [
      {
        "part_type": "receive",
        "status": "string",
        "number": "string",
        "revision": "string",
        "title": "string",
        "message": "string",
        "item_id": "8e8aa42241794371ae9d0ed7b67a8c86",
        "action_datetime": "2019-08-24T14:15:22Z",
        "from_organization_id": "8e8aa42241794371ae9d0ed7b67a8c86",
        "response_required_date": "2019-08-24",
        "fileset_zone": "string",
        "fileset_id": "8e8aa42241794371ae9d0ed7b67a8c86"
      }
    ]
  }'

Responses

Successfully changed 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 Item was created.

datetimeUpdatedstring(date-time)read-only

The date and time this Item 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"
project_idstring(CompactUUID)^[0-9a-fA-F]{32}$

UUID without hyphens (32 characters)

Example: "8e8aa42241794371ae9d0ed7b67a8c86"
item_disciplineobject(DisciplineWithId)

Defines the list of disciplines in TonicDM, and also defines whether that discipline initiates and/or receives each workflow type.

workflow_numberintegerread-only
is_internal_forwardbooleanread-only
stagestring
manual_stageboolean
Default false
manual_received_datetimestring(date-time)
manual_response_datetimestring(date-time)
our_response_required_datestring(date)
our_numberstring
our_revisionstring
our_titlestring

The overall title given to this Item, in the manner of the subject of an email. This will typically match the title of the received Part, but not always.

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

UUID without hyphens (32 characters)

Example: "8e8aa42241794371ae9d0ed7b67a8c86"
partsArray of objects(TaskPart)
Response
application/json
{
  "id": "8e8aa42241794371ae9d0ed7b67a8c86",
  "datetimeCreated": "2019-08-24T14:15:22Z",
  "datetimeUpdated": "2019-08-24T14:15:22Z",
  "status": "active",
  "project_id": "8e8aa42241794371ae9d0ed7b67a8c86",
  "item_discipline": {
    "id": "string",
    "nameInitials": "string",
    "nameShort": "string",
    "nameLong": "string"
  },
  "workflow_number": 0,
  "is_internal_forward": true,
  "stage": "string",
  "manual_stage": false,
  "manual_received_datetime": "2019-08-24T14:15:22Z",
  "manual_response_datetime": "2019-08-24T14:15:22Z",
  "our_response_required_date": "2019-08-24",
  "our_number": "string",
  "our_revision": "string",
  "our_title": "string",
  "responsible_person_id": "8e8aa42241794371ae9d0ed7b67a8c86",
  "parts": [
    { … }
  ]
}