REST API

With the Partek Flow REST API, you can create custom solutions to query or drive your server. Below are some common use cases for the REST API:

Generate an authentication token
Create a project

A complete reference for the API can be found on the or by visiting [server]/api/v1/servlets

The referenced Python library can be downloaded .

Generate an authentication token

An access token can be generated from the System information section of the settings page.

Alternatively, GetToken.py will generate a token:

you will be prompted to enter your password.

This token can be specified as the token parameter.

Create a project

Flow organizes data by projects and they can be created and managed by the REST API.

To create a project:

The server will respond with JSON data describing the new project:

The new project will appear on the Flow homepage:

Upload a group of samples

UploadSamples.py is a python script that can create samples within a project by uploading files:

This operation will generate a data node on the Analyses tab for the imported samples:

Assign sample attributes

We can associate attributes with samples for use in visualizations and statistical analysis:

The sample attributes can be viewed and managed on the data tab:

Run a pipeline

A pipeline is a series of tasks used to process and analyze genomic data. You can read more about pipelines

To run a pipeline, first we need to know its name.

We can get the name of a pipeline from the GUI or from the API:

Many pipelines also require that library files are specified.

You can get the list of required inputs for the pipeline from the API:

This particular pipeline requires a bowtie index and an annotation model:

The request to launch the pipeline needs to specify one resource ID for each input.

These IDs can be found using the API:

Get the IDs for the library files that match the required inputs

The pipeline can be launched in any project using RunPython.py

This action will cause two tasks to start running:

Alternatively, UploadSamples.py can create the project, upload the samples and launch the pipeline in one step:

Add a collaborator to a project

To add a collaborator to a project:

Transfer feature lists

Monitor a folder and upload files as they are created

Monitor the queue and send a notification if there are too many waiting tasks

Additional Assistance

If you need additional assistance, please visit to submit a help ticket or find phone numbers for regional support.

python GetToken.py --server localhost:8080 --user admin

curl --form token=cUOWY0VvkSFagr... http://localhost:8080/flow/api/v1/users/list

curl -X POST --form token=$FLOW_TOKEN --form project="My Project" http://localhost:8080/flow/api/v1/projects

{"name":"My Project","id":"0","description":"","owner":"0","userRoles":{"0":"Project owner"},"outputFolders":{"0":"/home/flow/FlowData/Project_My Project"},"diskUsage":"0 GB","lastModifiedTimeStamp":1506013662476,"lastModifiedDate":"12:00 PM","data":[]}

python UploadSamples.py --verbose --token $FLOW_TOKEN --server http://localhost:8080 --project "My Project" --files ~/MoreData/REST/sample1.fastq.gz ~/MoreData/REST/sample2.fastq.gz ~/MoreData/REST/sample3.fastq.gz ~/MoreData/REST/sample4.fastq.gz

python AddAttribute.py -v --server http://localhost:8080 --token $FLOW_TOKEN --project_name "My Project" --sample_name sample1 --attribute Type --value Case

python AddAttribute.py -v --server http://localhost:8080 --token $FLOW_TOKEN --project_name "My Project" --sample_name sample2 --attribute Type --value Case

python AddAttribute.py -v --server http://localhost:8080 --token $FLOW_TOKEN --project_name "My Project" --sample_name sample3 --attribute Type --value Control

python AddAttribute.py -v --server http://localhost:8080 --token $FLOW_TOKEN --project_name "My Project" --sample_name sample4 --attribute Type --value Control

wget -q -O - http://localhost:8080/flow/api/v1/pipelines/list$AUTHDETAILS | python -m json.tool | gvim -

wget -q -O - "http://localhost:8080/flow/api/v1/library_files/list${AUTHDETAILS}&assembly=hg19" |  python -m json.tool | gvim -

[
    {
        "annotationModel": "",
        "assembly": "hg19",
        "description": "Reference sequence",
        "fileType": "Genome sequence",
        "id": 100
    },
    {
        "annotationModel": "",
        "assembly": "hg19",
        "description": "Cytoband",
        "fileType": "cytoBand.txt",
        "id": 101
    },
    {
        "annotationModel": "",
        "assembly": "hg19",
        "description": "Bowtie index",
        "fileType": "Bowtie Index",
        "id": 102
    },
    {
        "annotationModel": "hg19_refseq_15_05_07_v2",
        "assembly": "hg19",
        "description": "Annotation file: hg19_refseq_15_05_07_v2",
        "fileType": "Annotation model",
        "id": 103
    }
]

python RunPipeline.py  -v --server http://localhost:8080 --token $FLOW_TOKEN --project_id 0 --pipeline AlignAndQuantify --inputs 102,103

python UploadSamples.py -v --server http://localhost:8080 --token $FLOW_TOKEN --files ~/sampleA.fastq.gz ~/sampleB.fastq.gz --project NewProject --pipeline AlignAndQuantify --inputs 102,103

curl -X PUT "http://localhost:8080/flow/api/v1/projects?project=ProjectName&collaborator=user1&role=Collaborator&token=$FLOW_TOKEN"

curl --form token=$TO_TOKEN --form url=http://from:8080/flow/api/v1/feature_lists/export?token=$FROM_TOKEN  http://to:8080/flow/api/v1/feature_lists/import

#!/bin/bash
inotifywait -m $PATH_TO_MONITOR -e create -e moved_to |
  while read path action file; do
      if [[ $file == *.fastq.gz ]]; then
              echo "Uploading $file"
              python UploadSamples.py -v --server $SERVER --token $FLOW_TOKEN --files $path/$file --project "$PROJECT"
      fi
  done

#!/bin/bash
while true; do
      result=`python QueueStatistics.py --server $SERVER --token $TOKEN --max_waiting $MAX_WAITING`
      if [ $? -eq 1 ]; then
              /usr/bin/notify-send $result
              exit 1
      fi
      sleep $INTERVAL
done

python GetToken.py --server localhost:8080 --user admin

curl --form token=cUOWY0VvkSFagr... http://localhost:8080/flow/api/v1/users/list

curl -X POST --form token=$FLOW_TOKEN --form project="My Project" http://localhost:8080/flow/api/v1/projects

{"name":"My Project","id":"0","description":"","owner":"0","userRoles":{"0":"Project owner"},"outputFolders":{"0":"/home/flow/FlowData/Project_My Project"},"diskUsage":"0 GB","lastModifiedTimeStamp":1506013662476,"lastModifiedDate":"12:00 PM","data":[]}

python UploadSamples.py --verbose --token $FLOW_TOKEN --server http://localhost:8080 --project "My Project" --files ~/MoreData/REST/sample1.fastq.gz ~/MoreData/REST/sample2.fastq.gz ~/MoreData/REST/sample3.fastq.gz ~/MoreData/REST/sample4.fastq.gz

python AddAttribute.py -v --server http://localhost:8080 --token $FLOW_TOKEN --project_name "My Project" --sample_name sample1 --attribute Type --value Case

python AddAttribute.py -v --server http://localhost:8080 --token $FLOW_TOKEN --project_name "My Project" --sample_name sample2 --attribute Type --value Case

python AddAttribute.py -v --server http://localhost:8080 --token $FLOW_TOKEN --project_name "My Project" --sample_name sample3 --attribute Type --value Control

python AddAttribute.py -v --server http://localhost:8080 --token $FLOW_TOKEN --project_name "My Project" --sample_name sample4 --attribute Type --value Control

wget -q -O - http://localhost:8080/flow/api/v1/pipelines/list$AUTHDETAILS | python -m json.tool | gvim -

wget -q -O - "http://localhost:8080/flow/api/v1/library_files/list${AUTHDETAILS}&assembly=hg19" |  python -m json.tool | gvim -

[
    {
        "annotationModel": "",
        "assembly": "hg19",
        "description": "Reference sequence",
        "fileType": "Genome sequence",
        "id": 100
    },
    {
        "annotationModel": "",
        "assembly": "hg19",
        "description": "Cytoband",
        "fileType": "cytoBand.txt",
        "id": 101
    },
    {
        "annotationModel": "",
        "assembly": "hg19",
        "description": "Bowtie index",
        "fileType": "Bowtie Index",
        "id": 102
    },
    {
        "annotationModel": "hg19_refseq_15_05_07_v2",
        "assembly": "hg19",
        "description": "Annotation file: hg19_refseq_15_05_07_v2",
        "fileType": "Annotation model",
        "id": 103
    }
]

python RunPipeline.py  -v --server http://localhost:8080 --token $FLOW_TOKEN --project_id 0 --pipeline AlignAndQuantify --inputs 102,103

python UploadSamples.py -v --server http://localhost:8080 --token $FLOW_TOKEN --files ~/sampleA.fastq.gz ~/sampleB.fastq.gz --project NewProject --pipeline AlignAndQuantify --inputs 102,103

curl -X PUT "http://localhost:8080/flow/api/v1/projects?project=ProjectName&collaborator=user1&role=Collaborator&token=$FLOW_TOKEN"

curl --form token=$TO_TOKEN --form url=http://from:8080/flow/api/v1/feature_lists/export?token=$FROM_TOKEN  http://to:8080/flow/api/v1/feature_lists/import

#!/bin/bash
inotifywait -m $PATH_TO_MONITOR -e create -e moved_to |
  while read path action file; do
      if [[ $file == *.fastq.gz ]]; then
              echo "Uploading $file"
              python UploadSamples.py -v --server $SERVER --token $FLOW_TOKEN --files $path/$file --project "$PROJECT"
      fi
  done

#!/bin/bash
while true; do
      result=`python QueueStatistics.py --server $SERVER --token $TOKEN --max_waiting $MAX_WAITING`
      if [ $? -eq 1 ]; then
              /usr/bin/notify-send $result
              exit 1
      fi
      sleep $INTERVAL
done

Enterprise Features and Toolkits

This document describes different license features in Partek Flow. Some license features are required in to initiate the software for the particular environment in which it is installed. Other license features (enterprise and toolkits) are optional and would depend on the particular needs of the users. For information on how to purchase the different license features, contact your account representative or email [email protected].

Partek Flow base
HPC node

To check the current license features of your Partek Flow, go to the Username > Settings > System Information > Partek Flow license details (Figure 1). Administrators can also see the information, as well as apply a new license through Username > Settings > Licensing page of the software (Figure 2).

Partek Flow base

The base license allows Partek Flow to run in an installation. It is the minimum required license to run Partek Flow.

HPC node

This feature allows Partek Flow to be installed in a High Performance Computing with multiple nodes cores.

Enterprise Features

User Disk Quotas

Administrators can specify disk-space quotas for users and actions to be performed at 80% and 100% of these quotas.
A Disk quota column appears on the User management page
Default disk quota, Actions at 80% of disk quota, and Actions at 100% of disk quota columns appear on the Settings > page

Dedicating Licenses to Groups

Administrators can dedicate some of the concurrent licenses to particular user groups, guaranteeing that that number of group users can always be logged in or running tasks and restricting other users from using those licenses.
This feature has an effect only for concurrent licenses.
All users see a Dedicated licenses column on the Group management page, but only administrators can change its values.

Usage Reports

Administrators can report information about users, user groups, projects, directories, file types, file compression, and disk quota and usage.
Only administrators can see and use the Settings > page.

Option Sets from Command Line

Users can convert command lines to option sets. An appears on the page.

Reprioritizing Tasks

Administrators can move a project’s tasks to the top of the task queue. Green up arrows () appear next to tasks in the task queue, and clicking one moves all of the tasks for that task’s project to the top (Figure 4).
The task queue can be accessed through the Queue>View queued tasks... at the top menu. It can also be accessed by clicking the server icon , and in the System resources page, click the View queued tasks link.

This provides programmatic access to your Partek Flow server using the command line

User Added Tasks

Administrators can add executables and scripts to the set of analysis tools available on a given installation
Once added, these User added tasks can be made visible to regular users using the Task Management Page

Toolkits

This license feature allows users to run the (includes Quantification, Normalization, Differential Gene Expression)

This license feature allows users to perform analysis of Single Cell RNA-seq data

DNA-seq Toolkit

This license feature allows users to run the Variant Calling (SNVs, indels, CNV) and Variant Annotation tools

Microarray Toolkit

Users can convert microarray data to unaligned reads. The conversion tasks for the aligners appear in the context-sensitive menu, under the section “Convert to Aligned Reads”. Refer to for additional details.

ChIP-Seq Toolkit

This license feature allows users to analyze data from ChIP-Seq experiments including peak detection, enrichment and annotation. Also compatible with other region enrichment experiments such as ATAC-Seq.

Additional Assistance

If you need additional assistance, please visit to submit a help ticket or find phone numbers for regional support.

Possible actions are Email user, Email administrators, and Prevent importing sample files and running tasks

A Disk usage row appears on the of each user

If a quota is set for a user, the Project disk space icon on the lower right of the Analyses tab will be replaced by a Quota disk space for the current user (Figure 3)

If a quota is set for a user, the Project disk space icon on the lower right of the Analyses tab will indicate the corresponding usage

REST API Command List

Structure of the URI
Authentication
Servlets

Structure of the URI

http://example.com:8080/flow/api/v1

Authentication

The username and access token must be supplied unless the request is made in an authenticated session.

The access token can be generated from the settings page or using the public key included in the PartekFlow-REST.zip as described in

Servlets

/servlets

since 7.0.180726

GET An up-to-date form of this documentation

Parameter

Type

Description

Default

Projects

/projects

since 7.0.18.0125

POST, PUT

Add or configure a project

Parameter

Type

Description

/projects

since 7.0.17.0803

DELETE

Delete projects

Parameter

Type

Description

/projects

since 7.0.17.0524

GET

Returns metadata about a project

/projects/cells

since 9.0.20.504

GET, POST, PUT

Summarizes the number of input cells in single-cell experiments

/projects/create

since 7.0.19.0120

GET, POST, PUT

Creates a new project

Parameter

Type

Description

/projects/error

since 7.0.18.0802

GET, POST, PUT

Get or set a project-specific error message

Parameter

Type

Description

/projects/export

since 7.0.16.1101

GET, POST, PUT

Export a specified project to a .zip file

Parameter

Type

Description

Default

/projects/file_entries

since 8.0.19.0701

GET, POST, PUT

Returns files associated with projects. Matches the files that can be deleted when the project is deleted

/projects/files

since 7.0.17.1101

GET, POST, PUT

Returns files associated with projects. Matches files used in the calculation of size shown on the homepage

/projects/folders

since 7.0.17.1101

GET, POST, PUT

Returns folders associated with projects

Parameter

Type

Description

/projects/import

since 7.0.16.1101

GET, POST, PUT

Import a project from an exported .zip file

Parameter

Type

Description

Default

/projects/list

since 7.0.17.1101

GET, POST, PUT

Returns a list of projects available on the server

Parameter

Type

Description

/projects/output_folders

since 7.0.17.1101

GET, POST, PUT

Returns the output folders for projects

Parameter

Type

Description

/projects/properties

since 7.0.18.0529

GET, POST, PUT

List or configure project-specific properties

Parameter

Type

Description

/projects/report

since 7.0.18.0902

GET, POST, PUT

Generates a tab-delimited report on tasks in a project

Parameter

Type

Description

/projects/resources

since 7.0.18.0910

GET, POST, PUT

Returns meta-data on resources associated with the project

Parameter

Type

Description

/projects/samples

since 7.0.17.1101

GET, POST, PUT

List samples associated with projects

Parameter

Type

Description

/projects/search

since 7.0.18.0529

GET, POST, PUT

Search for projects

Parameter

Type

Description

Default

/projects/transfer

since 9.0.20.0612

GET, POST, PUT

Manages transferring project to remote servers

Samples

/samples

since 7.0.17.0921

POST, PUT

Import a set of attributes

Parameter

Type

Description

Default

/samples

since 7.0.17.0921

GET, POST, PUT

Add or query a sample

Parameter

Type

Description

/samples/attributes

since 7.0.17.0915

GET, POST, PUT

Returns attributes associated with a sample

/samples/list

since 7.0.17.0921

GET, POST, PUT

Returns samples and attributes in a specified project

Parameter

Type

Description

/samples/rename

since 7.0.18.1212

GET, POST, PUT

Bulk rename samples

Parameter

Type

Description

Data

/data

since 7.0.18.0110

GET, POST, PUT

Upload data to the server

Parameter

Type

Description

Default

/data/attributes

since 7.0.18.0110

GET, POST, PUT

Returns attributes associated with a resource

Parameter

Type

Description

/data/files

since 7.0.18.0830

GET, POST, PUT

Returns the list of files associated with a resource

Parameter

Type

Description

/data/import_folder

since 10.0.21.2111

GET, POST, PUT

Imports all files in a specified folder

Parameter

Type

Description

Default

/data/managed

since 7.0.17.0817

GET, POST, PUT

Returns unmanaged files in a given directory

Parameter

Type

Description

/data/reassign

since 7.0.18.0710

GET, POST, PUT

Repair links to data that has changed directories

Parameter

Type

Description

/data/recover

since 7.0.19.0520

GET, POST, PUT

Recover disk space by deleting unnecessary files

/data/table

since 7.0.18.1120

GET, POST, PUT

Exports a task result table

Parameter

Type

Description

Default

/data/unmanaged

since 7.0.17.0817

GET, POST, PUT

Returns unmanaged files in a given directory

Parameter

Type

Description

/data/upload

since 9.0.20.0617

GET, POST, PUT

Uploads data to the server and then imports the uploaded data

Parameter

Type

Description

Default

Library files

/library_files

since 7.0.16.0826

GET, POST, PUT

Imports a library file

Parameter

Type

Description

/library_files/build

since 7.0.18.0207

GET, POST, PUT

Build a library file derived from an existing managed file

/library_files/files

since 7.0.17.0921

GET, POST, PUT

Returns metadata (including file paths) for managed library files

/library_files/list

since 7.0.17.0915

GET, POST, PUT

Returns metadata for managed library files

Parameter

Type

Description

/library_files/snp_eff

since 7.0.18.0619

GET, POST, PUT

Loads a manually downloaded SnpEff database. A SnpEff bin file must be present on the server under library files assembly/database/SnpEff database/database

Parameter

Type

Description

/library_files/types

since 7.0.17.0915

GET, POST, PUT

Returns available library file types

Pipelines

/pipelines

since 7.0.17.0921

GET, POST, PUT

Download the specified pipeline specification

Parameter

Type

Description

/pipelines/inputs

since 7.0.17.0921

GET, POST, PUT

List the inputs required by the specified pipeline

Parameter

Type

Description

Default

/pipelines/list

since 7.0.17.0921

GET, POST, PUT

Returns pipelines available on the server

/pipelines/ready

since 7.0.17.0921

GET, POST, PUT

Run the specified pipeline

Parameter

Type

Description

Default

/pipelines/run

since 7.0.17.0921

GET, POST, PUT

Run the specified pipeline

Parameter

Type

Description

Default

Queue

/queue

since 7.0.17.0901

GET, POST, PUT

Returns summary statistics of the task queue

Parameter

Type

Description

/queue/cancel

since 7.0.17.0901

GET, POST, PUT

Cancel tasks in progress

Parameter

Type

Description

/queue/commands

since 7.0.17.0901

GET, POST, PUT

Returns information about queued commands

/queue/downloads

since 7.0.17.0901

GET, POST, PUT

Returns the count of downloads in progress

/queue/status

since 10.0.22.0322

GET, POST, PUT

Check the queue status or request it start or stop handling commands

Parameter

Type

Description

/queue/tasks

since 7.0.17.0901

GET, POST, PUT

Returns information about tasks in the queue

Parameter

Type

Description

Users

/users

since 7.0.17.0901

POST, PUT

Add or configure users

Parameter

Type

Description

Default

/users

since 7.0.17.0901

GET

Returns information about a user

Parameter

Type

Description

Default

/users/files

since 8.0.19.0701

GET, POST, PUT

List files used by a specified user. Matches files used in the calculation of disk usage as reported on the Users settings page

/users/list

since 7.0.17.0901

GET, POST, PUT

Returns a list of known users

/users/logins

since 7.0.18.0102

GET, POST, PUT

Returns a list of logged in users and their last activity

/users/logout

since 9.0.20.1222

GET, POST, PUT

End the session of the specified user

Parameter

Type

Description

Default

/users/preferences

since 7.0.18.0912

GET, POST, PUT

Get and set user preferences

Parameter

Type

Description

/users/preferences/list

since 9.0.20.0625

GET, POST, PUT

Lists system preferences which can be set

/users/roles

since 7.0.18.0323

GET, POST, PUT

Returns a list of roles assigned to users

/users/unset_private_directory

since 7.0.17.1011

POST, PUT

Configures the specified user to no longer use a private directory, instead reverting to the server defaults

Parameter

Type

Description

Default

Roles

/roles

since 7.0.18.0710

GET, POST, PUT

Apply roles to users

Parameter

Type

Description

/roles

since 7.0.18.0710

DELETE

Remove roles from users

Parameter

Type

Description

/roles/list

since 7.0.18.0710

GET, POST, PUT

Returns a list of roles available on the server

/roles/privileges

since 7.0.18.0710

GET, POST, PUT

Returns a list of privileges available on the server

Permission

/permission

since 7.0.18.0213

GET, POST, PUT

Get or set enforcement of directory permissions

Parameter

Type

Description

/permission/add_directory

since 7.0.18.0213

GET, POST, PUT

Add permission to access a directory to a specified user

Parameter

Type

Description

Default

/permission/remove_directory

since 7.0.18.0213

GET, POST, PUT

Remove permission to access a directory from a specified user

Parameter

Type

Description

Default

Tasks

/tasks

since 7.0.17.0207

GET, POST, PUT

Returns information about tasks that have run on the server

Parameter

Type

Description

/tasks/delete

since 7.0.18.0207

DELETE, GET, POST

Deletes tasks

Parameter

Type

Description

Default

/tasks/inputs

since 9.0.20.1002

GET, POST, PUT

Returns task input values

Parameter

Type

Description

/tasks/license

since 7.0.18.0920

GET, POST, PUT

Returns a list of available tasks and their license requirements

/tasks/logs

since 7.0.18.0930

GET, POST, PUT

Returns task logs

Parameter

Type

Description

/tasks/outputs

since 7.0.18.1120

GET, POST, PUT

Returns task output resource IDs and descriptions

/tasks/reload

since 10.0.21.0525

GET, POST, PUT

Returns a list of task test specifications

/tasks/report

since 7.0.18.1130

GET, POST, PUT

Generates a report on recent tasks

Parameter

Type

Description

Default

/tasks/specs

since 7.0.18.0207

GET, POST, PUT

Returns a list of task test specifications

Filters

/filters

since 7.0.18.0207

GET, POST, PUT

Upload feature filters

Parameter

Type

Description

Commands

/commands

since 7.0.17.0901

GET, POST, PUT

Returns information about commands that have run on the server

Parameter

Type

Description

/commands/description

since 7.0.17.0901

GET, POST, PUT

Returns a description of commands that have run on the server

Parameter

Type

Description

/commands/fit

since 7.0.17.0901

GET, POST, PUT

Returns information about command fits

/commands/memory

since 7.0.17.0901

GET, POST, PUT

Returns the memory used by commands

Parameter

Type

Description

/commands/pending

since 7.0.18.1124

GET, POST, PUT

Returns a summary report on pending commands

/commands/prediction

since 7.0.17.0901

GET, POST, PUT

Returns the predicted utilization of commands

Parameter

Type

Description

/commands/report

since 7.0.18.0902

GET, POST, PUT

Generates a tab-delimited report on commands in a task

License

/license

since 7.0.17.0314

GET, POST, PUT

Returns information about license available on the server

Parameter

Type

Description

Workers

/workers

since 7.0.17.0901

GET, POST, PUT

Returns a load summary of all connected workers

/workers/count

since 7.0.17.0901

GET, POST, PUT

Returns the number of connected workers

/workers/internal

since 7.0.17.0901

GET, POST, PUT

Returns a load summary of the internal worker, if it is enabled

/workers/remote

since 7.0.17.0901

GET, POST, PUT

Returns a summary of the load of remote workers

/workers/shutdown

since 10.21.0723

GET, POST, PUT

Shuts down workers

Parameter

Type

Description

Default

/workers/start

since 10.21.0723

GET, POST, PUT

Starts the internal worker

/workers/submitted

since 18.0930

GET, POST, PUT

Get and set information about workers that have been submitted to a cluster, but may not yet have connected

Parameter

Type

Description

System

/system

since 7.0.17.0227

GET, POST, PUT

System configuration options

Parameter

Type

Description

/system/dump_heap

since 10.0.21.0709

GET, POST, PUT

Dumps contents of heap

Parameter

Type

Description

/system/execution

since 10.0.23.0322

GET, POST, PUT

Configure execution of immediate commands, that support the front-end

Parameter

Type

Description

/system/generate_token

since 7.0.18.1020

GET, POST, PUT

Generate an access token for the requesting user

Parameter

Type

Description

Default

/system/import

since 7.0.18.0228

POST, PUT

Import a set of server preferences from a json specification

/system/logging

since 7.0.17.1024

GET, POST, PUT

Configure log levels

Parameter

Type

Description

/system/logs

since 10.0.23.0203

GET, POST, PUT

Download system logs

/system/package

since 10.0.23.0301

GET, POST, PUT

Query or override package paths

Parameter

Type

Description

/system/preferences

since 7.0.18.0130

DELETE

Delete preferences, reverting the values to default

Parameter

Type

Description

/system/preferences

since 7.0.18.0130

GET, POST, PUT

Get and set system preferences

Parameter

Type

Description

/system/preferences/list

since 9.0.20.0625

GET, POST, PUT

Lists system preferences which can be set

/system/preferences/nodes

since 7.0.18.0130

GET, POST, PUT

Returns a list of preference node names

/system/revoke

since 7.0.18.1020

GET, POST, PUT

Revoke API access tokens

Parameter

Type

Description

/system/stacks

since 8.0.23.0419

GET, POST, PUT

Return a stack trace of current activity

/system/status_report

since 8.0.20.0130

GET, POST, PUT

Report on recent system activity

Parameter

Type

Description

Default

/system/token

since 18.07.0930

GET, POST, PUT

Manage access tokens

Parameter

Type

Description

Default

/system/token/list

since 7.0.18.1020

GET, POST, PUT

Lists all managed tokens (Requires View user accounts privilege)

Additional Assistance

If you need additional assistance, please visit to submit a help ticket or find phone numbers for regional support.

If this parameter is specified, then “role” must also be specified. If the role parameter is “remove” then the specified collaborator is removed from the project, otherwise role must be a valid project role (Collaborator or Viewer).

my_output_folder

string

Sets the project output folder for the user making the request

output_folder

string

Sets the project output folder for all collaborators the user making the request has permission to affect

task

integer

Export project with this task as the root node

includeDownstream

boolean

If true then tasks downstream of the specified will be included

false

outputFolder

String

A path on the server to write the exported projects to.

Stream the project(s) to the requestor

List projects that contain a file matching the specified sub-string

user_id

integer