Cloud File Systems
/
Get Cloud Folder Children

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

Get Cloud Folder Children

Request

Retreive the children associated with a cloud file system path. This endpoint is used sucessively to navigate the file system.

This endpoint can accept:

  • just a platform, in which case the children of the root of the file system will be listed.
  • an ID of the folder to list
  • a Project ID, and if that project in TonicDM is configured with a root folder for the given platform, that folder will be listed. If no project-specific root folder is configured, the root for the platform will be listed.
  • a Project ID and Workflow name, and if that workflow in TonicDM is configured with a root folder for the given platform and project, that folder will be listed. If no workflow-specific root folder is configured, the root for the project will be used. And if no project-specific root folder is configured, the root for the platform will be listed.
Query
platformstringrequired

Defines the cloud platform to use.

Enum"egnyte""sharepoint""msgraph""procore""acc"
Example: platform=egnyte
folderIdstring

The ID of the parent folder in the cloud file system (not its path).

projectIdstring

The ID of the parent folder in the cloud file system (not its path).

workflowstring

The name of the relevant Workflow. If no parentId is provided, and a projectId is provided, and a path to that project's folder for this workflow can be determined, then its children will be returned.

searchQuerystring(JSON)

A JSON-encoded string containing the query options.

Example: searchQuery={"example"}
sortDirectionstring

The sort direction for the results

Enum"asc""desc"
curl -i -X GET \
  'https://developers-internal.tonicdm.com/_mock/tonicdm-product/fileset/cloudfilesystem-children?folderId=string&platform=egnyte&projectId=string&searchQuery={%22example%22}&sortDirection=asc&workflow=string' \
  -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 [
idstringread-onlyrequired

the Id of the file or folder as defined in its host cloud file system.

datetimeCreatedstring(date-time)read-only

The date and time this File record was created.

datetimeUpdatedstring(date-time)read-only

The date and time this File record was last updated.

statusstringread-only

The status of the File, with Inactive meaning it has been superceded (ie. another file with the same name was subsequently uploaded to the Fileset) removed from the Fileset.

Enum"Active""Inactive"
isFolderbooleanread-only

True if this is a folder, false if it is a file.

pathstringread-onlyrequired

The relative path to the file (from the root of the cloud file system).

namestringread-onlyrequired

The name of the folder or the file (with extension).

sizeintegerread-only

The size of the file in bytes.

fileCategorystring(fileCategory)

A list of functional categories for grouping files.

Default "none"
Enum"3d""audio-video""cad""calendar""contact""email""gis""image""pdf""presentations"
]
Response
application/json
[
  {
    "id": "string",
    "datetimeCreated": "2019-08-24T14:15:22Z",
    "datetimeUpdated": "2019-08-24T14:15:22Z",
    "status": "Active",
    "isFolder": true,
    "path": "string",
    "name": "string",
    "size": 0,
    "fileCategory": "3d"
  }
]

New Cloud Folder Child

Request

Creates a new child folder in the parent folder. This cannot be used to add a file to a folder.

Bodyapplication/jsonrequired
fileCategorystring(fileCategory)

A list of functional categories for grouping files.

Default "none"
Enum"3d""audio-video""cad""calendar""contact""email""gis""image""pdf""presentations"
curl -i -X POST \
  https://developers-internal.tonicdm.com/_mock/tonicdm-product/fileset/cloudfilesystem-children \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "fileCategory": "3d"
  }'

Responses

Successfully created the resource you sent

Bodyapplication/json
idstringread-onlyrequired

the Id of the file or folder as defined in its host cloud file system.

datetimeCreatedstring(date-time)read-only

The date and time this File record was created.

datetimeUpdatedstring(date-time)read-only

The date and time this File record was last updated.

statusstringread-only

The status of the File, with Inactive meaning it has been superceded (ie. another file with the same name was subsequently uploaded to the Fileset) removed from the Fileset.

Enum"Active""Inactive"
isFolderbooleanread-only

True if this is a folder, false if it is a file.

pathstringread-onlyrequired

The relative path to the file (from the root of the cloud file system).

namestringread-onlyrequired

The name of the folder or the file (with extension).

sizeintegerread-only

The size of the file in bytes.

fileCategorystring(fileCategory)

A list of functional categories for grouping files.

Default "none"
Enum"3d""audio-video""cad""calendar""contact""email""gis""image""pdf""presentations"
Response
application/json
{
  "id": "string",
  "datetimeCreated": "2019-08-24T14:15:22Z",
  "datetimeUpdated": "2019-08-24T14:15:22Z",
  "status": "Active",
  "isFolder": true,
  "path": "string",
  "name": "string",
  "size": 0,
  "fileCategory": "3d"
}

Edit Cloud Folder Child

Request

Change the name of an existing file or folder.

Bodyapplication/jsonrequired
fileCategorystring(fileCategory)

A list of functional categories for grouping files.

Default "none"
Enum"3d""audio-video""cad""calendar""contact""email""gis""image""pdf""presentations"
curl -i -X PATCH \
  https://developers-internal.tonicdm.com/_mock/tonicdm-product/fileset/cloudfilesystem-children \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "fileCategory": "3d"
  }'

Responses

Successfully updated the resource you sent

Response
No content

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