RFIs

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 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

Get RFIs

Request

Get RFIs stored in the Workflow module.

Query
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}
filterWorkflowsArray of strings

Provide the names of one or more workflows separated by comma (no spaces).

Example: filterWorkflows=rfi,submittal,pco
filterStagesArray of strings(uuid)

Provide the GUIDs of one or more offices separated by comma (no spaces).

Example: filterStages=open,forwarded,void
filterFromArray of strings(email)

Provide one or more email addresses that any of the Parts of the Item are From, separated by comma (no spaces). This includes Receive, Forward, ReturnOfForward and Response parts.

Example: filterFrom=eddie@atlas-gc.com
filterToArray of strings(email)

Provide one or more email addresses that any of the Parts of the Item are To, separated by comma (no spaces). This includes Receive, Forward, ReturnOfForward and Response parts.

Example: filterTo=patti@argo-structural.com,mel@pacific-architects.com
filterCcArray of strings(email)

Provide one or more email addresses that any of the Parts of the Item are CC, separated by comma (no spaces). This includes Receive, Forward, ReturnOfForward and Response parts.

Example: filterCc=rita@argo-structural.com,stuart@pacific-architects.com
curl -i -X GET \
  'https://developers-internal.tonicdm.com/_mock/tonicdm-product/workflow/rfis?filterCc=rita%40argo-structural.com%2Cstuart%40pacific-architects.com&filterFrom=eddie%40atlas-gc.com&filterIds={id}%2C{id}%2C{id}&filterStages=open%2Cforwarded%2Cvoid&filterTo=patti%40argo-structural.com%2Cmel%40pacific-architects.com&filterWorkflows=rfi%2Csubmittal%2Cpco' \
  -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 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}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
item_disciplineobject(DisciplineWithId)

The list of disciplines in TonicDM.

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}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
reasonCodeobject(RfiReasonCodeWithId)

An RFI Reason Code

partsArray of objects(RfiPart)
]
Response
application/json
[
  {
    "id": "be26af2278974fddb5fcf67d83c10de4"
  },
  {
    "id": "be26af2278974fddb5fcf67d83c10de3"
  }
]

Create RFI

Request

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

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

The list of disciplines in TonicDM.

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}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
reasonCodeobject(RfiReasonCodeWithId)

An RFI Reason Code

partsArray of objects(RfiPart)
curl -i -X POST \
  https://developers-internal.tonicdm.com/_mock/tonicdm-product/workflow/rfis \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "status": "active",
    "project_id": "8e8aa42241794371ae9d0ed7b67a8c86",
    "item_discipline": {
      "id": "8e8aa42241794371ae9d0ed7b67a8c86"
    },
    "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",
    "reasonCode": {
      "id": "8e8aa42241794371ae9d0ed7b67a8c86",
      "brandId": "8e8aa42241794371ae9d0ed7b67a8c86",
      "name": "string"
    },
    "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}$
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}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
item_disciplineobject(DisciplineWithId)

The list of disciplines in TonicDM.

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}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
reasonCodeobject(RfiReasonCodeWithId)

An RFI Reason Code

partsArray of objects(RfiPart)
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": "8e8aa42241794371ae9d0ed7b67a8c86",
    "initials": "string",
    "abbreviation": "string",
    "name": "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",
  "reasonCode": {
    "id": "8e8aa42241794371ae9d0ed7b67a8c86",
    "datetimeCreated": "2019-08-24T14:15:22Z",
    "datetimeUpdated": "2019-08-24T14:15:22Z",
    "brandId": "8e8aa42241794371ae9d0ed7b67a8c86",
    "name": "string"
  },
  "parts": [
    { … }
  ]
}

Change an RFI

Request

Change an RFI.

Bodyapplication/json
idstring(CompactUUID)^[0-9a-fA-F]{32}$required
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}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
item_disciplineobject(DisciplineWithId)

The list of disciplines in TonicDM.

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}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
reasonCodeobject(RfiReasonCodeWithId)

An RFI Reason Code

partsArray of objects(RfiPart)
curl -i -X PATCH \
  https://developers-internal.tonicdm.com/_mock/tonicdm-product/workflow/rfis \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "8e8aa42241794371ae9d0ed7b67a8c86",
    "status": "active",
    "project_id": "8e8aa42241794371ae9d0ed7b67a8c86",
    "item_discipline": {
      "id": "8e8aa42241794371ae9d0ed7b67a8c86"
    },
    "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",
    "reasonCode": {
      "id": "8e8aa42241794371ae9d0ed7b67a8c86",
      "brandId": "8e8aa42241794371ae9d0ed7b67a8c86",
      "name": "string"
    },
    "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}$
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}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
item_disciplineobject(DisciplineWithId)

The list of disciplines in TonicDM.

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}$
Example: "8e8aa42241794371ae9d0ed7b67a8c86"
reasonCodeobject(RfiReasonCodeWithId)

An RFI Reason Code

partsArray of objects(RfiPart)
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": "8e8aa42241794371ae9d0ed7b67a8c86",
    "initials": "string",
    "abbreviation": "string",
    "name": "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",
  "reasonCode": {
    "id": "8e8aa42241794371ae9d0ed7b67a8c86",
    "datetimeCreated": "2019-08-24T14:15:22Z",
    "datetimeUpdated": "2019-08-24T14:15:22Z",
    "brandId": "8e8aa42241794371ae9d0ed7b67a8c86",
    "name": "string"
  },
  "parts": [
    { … }
  ]
}

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