/

Create a Reason Code

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

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

Get Reason Codes

Request

Returns a list of all Reason Codes for the user's Brand.

Query

searchQuerystring(JSON)

A JSON-encoded string containing the query options.

Example: searchQuery={"example"}

filterIdsArray of strings(CompactUUID)

Returns data for the specified GUIDs

Example: filterIds={id},{id},{id}

dataQuantityboolean

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 false

Example: dataQuantity=true

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/workflow/rfi-reason-codes?dataQuantity=true&filterIds={id}%2C{id}%2C{id}&pageNumber=1&pageSize=100&searchQuery={%22example%22}&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}$

UUID without hyphens (32 characters)

Example: "8e8aa42241794371ae9d0ed7b67a8c86"

datetimeCreatedstring(date-time)read-only

The date and time this record was created.

datetimeUpdatedstring(date-time)read-only

The date and time this record was last updated.

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

UUID without hyphens (32 characters)

Example: "8e8aa42241794371ae9d0ed7b67a8c86"

namestring[ 1 .. 64 ] characters

The name given to this Reason Code.

]

Response

application/json

[
  {
    "id": "8e8aa42241794371ae9d0ed7b67a8c86",
    "datetimeCreated": "2019-08-24T14:15:22Z",
    "datetimeUpdated": "2019-08-24T14:15:22Z",
    "brandId": "8e8aa42241794371ae9d0ed7b67a8c86",
    "name": "string"
  }
]

Create a Reason Code

Request

Creates a new RFI Reason Code for the Brand.

Bodyapplication/json

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

UUID without hyphens (32 characters)

Example: "8e8aa42241794371ae9d0ed7b67a8c86"

namestring[ 1 .. 64 ] characters

The name given to this Reason Code.

curl -i -X POST \
  https://developers-internal.tonicdm.com/_mock/tonicdm-product/workflow/rfi-reason-codes \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "brandId": "8e8aa42241794371ae9d0ed7b67a8c86",
    "name": "string"
  }'

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

datetimeUpdatedstring(date-time)read-only

The date and time this record was last updated.

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

UUID without hyphens (32 characters)

Example: "8e8aa42241794371ae9d0ed7b67a8c86"

namestring[ 1 .. 64 ] characters

The name given to this Reason Code.

Response

application/json

{
  "id": "8e8aa42241794371ae9d0ed7b67a8c86",
  "datetimeCreated": "2019-08-24T14:15:22Z",
  "datetimeUpdated": "2019-08-24T14:15:22Z",
  "brandId": "8e8aa42241794371ae9d0ed7b67a8c86",
  "name": "string"
}

Edit a Reason Code

Request

Edit an RFI Reason Code in the Brand.

Bodyapplication/json

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

UUID without hyphens (32 characters)

Example: "8e8aa42241794371ae9d0ed7b67a8c86"

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

UUID without hyphens (32 characters)

Example: "8e8aa42241794371ae9d0ed7b67a8c86"

namestring[ 1 .. 64 ] characters

The name given to this Reason Code.

curl -i -X PATCH \
  https://developers-internal.tonicdm.com/_mock/tonicdm-product/workflow/rfi-reason-codes \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "8e8aa42241794371ae9d0ed7b67a8c86",
    "brandId": "8e8aa42241794371ae9d0ed7b67a8c86",
    "name": "string"
  }'

Responses

Successfully updated the resource you requested.

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

datetimeUpdatedstring(date-time)read-only

The date and time this record was last updated.

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

UUID without hyphens (32 characters)

Example: "8e8aa42241794371ae9d0ed7b67a8c86"

namestring[ 1 .. 64 ] characters

The name given to this Reason Code.

Response

application/json

{
  "id": "8e8aa42241794371ae9d0ed7b67a8c86",
  "datetimeCreated": "2019-08-24T14:15:22Z",
  "datetimeUpdated": "2019-08-24T14:15:22Z",
  "brandId": "8e8aa42241794371ae9d0ed7b67a8c86",
  "name": "string"
}

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