Page History

...

/projects/cells

since 9.0.20.504

GET, POST, PUT, GET

Summarizes the number of input cells in single-cell experiments

/projects/create

since 7.0.19.0120

GET, POST, PUT, GET

Creates a new project

Parameter	Type	Description
project	String	The name of the new project
new_folder	String	Creates a new unique subfolder for this project

/projects/error

since 7.0.18.0802

GET, POST, PUT, GET

Get or set a project-specific error message

Parameter

Type

Description

project_id or project

integer or string

A project specification

message

String

ggvG

/projects/export

since 7.0.16.1101

GET, POST, PUT, GET

Export a specified project to a .zip file

Parameter	Type	Description	Default
project_ids	comma-delimited integers	A specification for one or more projects
includeLibraryFiles	boolean	If true then library files will be included	false
toProject	boolean	If true then rather than downloading a zip file, a new project will be created on the server
task	integer	Export project with this task and any downstream tasksas 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

/projects/file_entries

since 8.0.19.0701

GET, POST, PUT, GET

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

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

Returns folders associated with projects

...

/projects/import

since 7.0.16.1101

GET, POST, PUT, GET

Import a project from an exported .zip file

...

/projects/list

since 7.0.17.1101

GET, POST, PUT, GET

Returns a list of projects available on the server

...

/projects/output_folders

since 7.0.17.1101

GET, POST, PUT, GET

Returns the output folders for projects

...

/projects/properties

since 7.0.18.0529

GET, POST, PUT, GET

List or configure project-specific properties

...

/projects/report

since 7.0.18.0902

GET, POST, PUT, GET

Generates a tab-delimited report on tasks in a project

...

/projects/resources

since 7.0.18.0910

GET, POST, PUT, GET

Returns meta-data on resources associated with the project

...

/projects/samples

since 7.0.17.1101

GET, POST, PUT, GET

List samples associated with projects

...

/projects/search

since 7.0.18.0529

GET, POST, PUT, GET

Search for projects

Parameter	Type	Description	Default
exact	boolean	If true, the search term must match exactly, otherwise sub-string matches are allowed	false
category	String	Search for categories applied to samples
attribute	String	Search by attribute name
sample	String	Search by sample name

/projects/transfer

since 9.0.20.0612

GET, POST, PUT, GET

Manages transferring project to remote servers

...

Parameter	Type	Description	Default
attribute_json	String	A set of attributes in the same format as returned by /samples/attributes
attribute_txt	String	A set of attributes in a tab-delimited file
force	boolean	false	Attribute files with more than 10,000 samples are assumed to be for single cell data, specify force=true to override this
sample_id or sample_name	integer or string	A sample specification
(attribute or numeric_attribute) and value	String

/samples

since 7.0.17.0921

GET, POST, PUT, GET

Add or query a sample

Parameter	Type	Description
project_id or project	integer or string	A project specification
sample_id or sample_name	integer or string	A sample specification

/samples/attributes

since 7.0.17.0915

GET, POST, PUT, GET

Returns attributes associated with a sample

/samples/list

since 7.0.17.0921

GET, POST, PUT, GET

Returns samples and attributes in a specified project

...

/samples/rename

since 7.0.18.1212

GET, POST, PUT, GET

Bulk rename samples

Parameter	Type	Description
project_id or project	integer or string	A project specification
remove	String	Remove this substring from each sample name
trim_left	integer	Remove this many characters from the beginning of the sample name
trim_right	integer	Remove this many characters from the end of the sample name

Data

/data

since 7.0.18.0110

GET, POST, PUT, GET

Upload data to the server

...

/data/attributes

since 7.0.18.0110

GET, POST, PUT, GET

Returns attributes associated with a resource

...

/data/files

since 7.0.18.0830

GET, POST, PUT, GET

Returns the list of files associated with a resource

Parameter	Type	Description
resource_id	integer	A resource ID

/data/import_folder

since 10.0.21.2111

GET, POST, PUT

Imports all files in a specified folder

Parameter	Type	Description	Default
folder	String	path to the data on the server
project	String	Project to import to	Creates a project based on the folder name

/data/managed

since 7.0.17.0817

GET, POST, PUT, GET

Returns unmanaged files in a given directory

...

/data/reassign

since 7.0.18.0710

GET, POST, PUT, GET

Repair links to data that has changed directories

...

/data/recover

since 7.0.19.0520

GET, POST, PUT, GET

Recover disk space by deleting unnecessary files

/data/table

since 7.0.18.1120

GET, POST, PUT, GET

Exports a task result table

...

/data/unmanaged

since 7.0.17.0817

GET, POST, PUT, GET

Returns unmanaged files in a given directory

...

/data/upload

since 9.0.20.0617

GET, POST, PUT, GET

Uploads data to the server and then imports the uploaded data

...

/library_files

since 7.0.16.0826

GET, POST, PUT, GET

Imports a library file

Parameter	Type	Description
file or filepath	binary or string	The file content or the path of the file on the server
file_type	String	The type of library file. The list of available library file types is returned by /library_files/types
assembly	String	The assembly of the library file
species	string	The species of the library file. This is looked up based on the assembly, and the assembly is used as the species if the assembly is not associated with any species

/library_files/build

since 7.0.18.0207

GET, POST, PUT, GET

Build a library file derived from an existing managed file

/library_files/files

since 7.0.17.0921

GET, POST, PUT, GET

Returns metadata (including file paths) for managed library files

/library_files/list

since 7.0.17.0915

GET, POST, PUT, GET

Returns metadata for managed library files

...

/library_files/snp_eff

since 7.0.18.0619

GET, POST, PUT, GET

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

...

/library_files/types

since 7.0.17.0915

GET, POST, PUT, GET

Returns available library file types

...

/pipelines

since 7.0.17.0921

GET, POST, PUT, GET

Download the specified pipeline specification

...

/pipelines/inputs

since 7.0.17.0921

GET, POST, PUT, GET

List the inputs required by the specified pipeline

...

/pipelines/list

since 7.0.17.0921

GET, POST, PUT, GET

Returns pipelines available on the server

/pipelines/ready

since 7.0.17.0921

GET, POST, PUT, GET

Run the specified pipeline

...

/pipelines/run

since 7.0.17.0921

GET, POST, PUT, GET

Run the specified pipeline

...

Queue

/queue

since 7.0.17.0901

GET, POST, PUT, GET

Returns summary statistics of the task queue

...

/queue/cancel

since 7.0.17.0901

GET, POST, PUT

Cancel tasks in progress

...

/queue/commands

since 7.0.17.0901

GET, POST, PUT, GET

Returns information about queued commands

/queue/downloads

since 7.0.17.0901

GET, POST, PUT, GET

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
op	string	Operation start

/queue/tasks

since 7.0.17.0901

GET, POST, PUT, GET

Returns information about tasks in the queue

...

/users/files

since 8.0.19.0701

GET, POST, PUT, GET

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

/users/list

since 7.0.17.0901

GET, POST, PUT, GET

Returns a list of known users

/users/logins

since 7.0.18.0102

GET, POST, PUT, GET

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
user_id or user_name	integer or string	A user specification.	The user to logoff. If this is not specified, the user making the request will be used

/users/preferences

since 7.0.18.0912

GET, POST, PUT, GET

Get and set user preferences

...

/users/preferences/list

since 9.0.20.0625

GET, POST, PUT, GET

Lists system preferences which can be set

/users/roles

since 7.0.18.0323

GET, POST, PUT, GET

Returns a list of roles assigned to users

...

Roles

/roles

since 7.0.18.0710

GET, POST, PUT, GET

Apply roles to users

Parameter	Type	Description
file	binary	A json file which contains a list of RolePrivileges (as returned by roles/list

...

/roles/list

since 7.0.18.0710

GET, POST, PUT, GET

Returns a list of roles available on the server

/roles/privileges

since 7.0.18.0710

GET, POST, PUT, GET

Returns a list of privileges available on the server

...

/permission

since 7.0.18.0213

GET, POST, PUT, GET

Get or set enforcement of directory permissions

...

/permission/add_directory

since 7.0.18.0213

GET, POST, PUT, GET

Add permission to access a directory to a specified user

...

/permission/remove_directory

since 7.0.18.0213

GET, POST, PUT, GET

Remove permission to access a directory from a specified user

Parameter	Type	Description	Default
directory	String
user_id or user_name or group_id or group_name	integer or string or integer or string	A member specification	If a user or group is not specified, this action will apply to all users

Tasks

/tasks

since 7.0.18.0207

DELETE

Deletes tasks

...

Parameter

...

Type

...

Description

...

Default

...

id

...

integer

...

keep_output

...

boolean

...

false

/tasks

since 7.0.17.0207

GET, POST, PUT, GET

Returns information about tasks that have run on the server

Parameter	Type	Description
project_id or project	integer or string	A project specification
id	integer	A single task ID
user_name or user_id	string or integer	The username or ID of a user that has run tasks
status	String	A task status: Pending, Waiting, Running, Done, Canceled, Failed
task	String	A sub-string of the task name & version as it appears in the Task entry on the task details page

/tasks/delete

since 7.0.18.0207

DELETE, GET, POST

Deletes tasks

Parameter	Type	Default
project_id	integer
id	integer
keep_output	boolean	false
task_type	String

/tasks/inputs

since 9.0.20.1002

GET, POST, PUT

Returns task input values

Parameter	Type	Description
slots	string	A comma-delimited list of input slots to query

/tasks/license

since 7.0.18.0920

GET, POST, PUT, GET

Returns a list of available tasks and their license requirements

/tasks/logs

since 7.0.18.0930

GET, POST, PUT, GET

Returns task logs

Parameter	Type	Description
project_id or project	integer or string	A project specification
id	integer	A single task ID
user_name or user_id	string or integer	The username or ID of a user that has run tasks
status	String	A task status: Pending, Waiting, Running, Done, Canceled, Failed
task	String	A sub-string of the task name & version as it appears in the Task entry on the task details page

/tasks/outputs

since 7.0.18.1120

GET, POST, PUT, GET

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

Generates a report on recent tasks

Parameter	Type	Description	Default
recent	boolean	Set to false to report on all tasks	true

/tasks/specs

since 7.0.18.0207

GET, POST, PUT, GET

Returns a list of task test specifications

Filters

/filters

since 7.0.18.0207

GET, POST, PUT, GET

Upload feature filters

Parameter	Type	Description
filepath or filter	String	filepath: a file on the server with filter content or filter: the filter content in json format

...

/commands

since 7.0.17.0901

GET, POST, PUT, GET

Returns information about commands that have run on the server

...

/commands/description

since 7.0.17.0901

GET, POST, PUT, GET

Returns a description of commands that have run on the server

...

/commands/fit

since 7.0.17.0901

GET, POST, PUT, GET

Returns information about command fits

/commands/memory

since 7.0.17.0901

GET, POST, PUT, GET

Returns the memory used by commands

...

/commands/pending

since 7.0.18.1124

GET, POST, PUT, GET

Returns a summary report on pending commands

/commands/prediction

since 7.0.17.0901

GET, POST, PUT, GET

Returns the predicted utilization of commands

...

/commands/report

since 7.0.18.0902

GET, POST, PUT, GET

Generates a tab-delimited report on commands in a task

License

/license

since 7.0.17.0314

GET, POST, PUT, GET

Returns information about license available on the server

...

Workers

/workers

since 7.0.17.0901

GET, POST, PUT, GET

Returns a load summary of all connected workers

/workers/count

since 7.0.17.0901

GET, POST, PUT, GET

Returns the number of connected workers

/workers/internal

since 7.0.17.0901

GET, POST, PUT, GET

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

/workers/remote

since 7.0.17.0901

GET, POST, PUT, GET

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
internal	boolean	Shut down the internal worker	true
external	boolean	Shut down all external workers	true
id	integer	Shut down only the worker matching this identifier

/workers/start

since 10.21.0723

GET, POST, PUT

Starts the internal worker

/workers/submitted

since 18.0930

GET, POST, PUT, GET

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

...

System

/system

since 7.0.17.0227

GET, POST, PUT, GET

System configuration options

Parameter	Type	Description
page_load_log_threshold	integer	If specified and greater than 0 a warning will be written to logs/page_load.log whenever a page-load takes longer than this value (in seconds)
reload_import_config	boolean	Reload the partek_db/import.config file
reload_help_config	boolean	Reload the partek_db/help.config file
update_command_resources	boolean	Download and update command resource estimates
reload_feature_lists	boolean	Reload the feature lists for the user

/system/dump_heap

since 10.0.21.0709

GET, POST, PUT

Dumps contents of heap

Parameter	Type	Description
file	string	Path to write the hprof heap dump

/system/execution

since 10.0.23.0322

GET, POST, PUT

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

Parameter	Type	Description
synchronous_threadpool	integer	Number of threads to use for the synchronous executor
dispatch_method	string	An optional method for dispatching commands that must run immediately

/system/generate_token

since 7.0.18.1020

GET, POST, PUT, GET

Generate an access token for the requesting user

...

/system/logging

since 7.0.17.1024

GET, POST, PUT, GET

Configure log levels

Parameter	Type	Description
logger	string	The name of a logger or "commands" to configure multiple command-related logs.
log_level	string	Sets the level of the specified logger: ALL, TRACE, DEBUG, INFO, WARN, ERROR, OFF

/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
get	string	Return current path to package
package	string	Set the path of the specified package

/system/preferences

since 7.0.18.0130

...

/system/preferences

since 7.0.18.0130

GET, POST, PUT, GET

Get and set system preferences

...

/system/preferences/list

since 9.0.20.0625

GET, POST, PUT, GET

Lists system preferences which can be set

/system/preferences/nodes

since 7.0.18.0130

GET, POST, PUT, GET

Returns a list of preference node names

/system/revoke

since 7.0.18.1020

GET, POST, PUT, GET

Revoke API access tokens

Parameter	Type	Description
api_key	String	An API token to revoke. "mine" to revoke the requestors tokens, "all" to revoke all managed tokens (requires Change user accounts privilege)

/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, GET

Report on recent system activity

Parameter	Type	Description	Default
all_threads	boolean	Show all threads (rather than just those with partek in the class name)	false
heap_dump	boolean	Write heap dump to the logs	false
io	boolean	Measure the time to write & read a file from mount points	false
gc	boolean	Request System.gc before reporting memory usage	true
log	boolean	Include the last section of content from various log files	true
tasks	boolean	Include the section on running / pending tasks	true
top	boolean	Write the output of top to the output	false
cpu_load_threshold	integer	Print a warning if the system load average exceeds this value
mem_load_threshold	integer	Print a warning if the percent of heap used exceeds this value

/system/token

since 18.07.0930

GET, POST, PUT, GET

Manage access tokens

Parameter	Type	Description	Default
api_key	String	The token to configure	Return a list of all tokens managed for the requestor
expiration	String	never for no expiration, otherwise: d-M-yyyy h:mm a

/system/token/list

since 7.0.18.1020

GET, POST, PUT, GET

Lists all managed tokens (Requires View user accounts privilege)

...

Rate Macro

allowUsers	false

Partek Flow Documentation

Page tree

Page History

Versions Compared

Old Version 28

New Version Current

Key

/projects/cells

/projects/create

/projects/error

/projects/export

/projects/file_entries

/projects/files

/projects/folders

/projects/import

/projects/list

/projects/output_folders

/projects/properties

/projects/report

/projects/resources

/projects/samples

/projects/search

/projects/transfer

/samples

/samples/attributes

/samples/list

/samples/rename

Data

/data

/data/attributes

/data/files

/data/import_folder

/data/managed

/data/reassign

/data/recover

/data/table

/data/unmanaged

/data/upload

/library_files

/library_files/build

/library_files/files

/library_files/list

/library_files/snp_eff

/library_files/types

/pipelines

/pipelines/inputs

/pipelines/list

/pipelines/ready

/pipelines/run

Queue

/queue

/queue/cancel

/queue/commands

/queue/downloads

/queue/status

/queue/tasks

/users/files

/users/list

/users/logins

/users/logout

/users/preferences

/users/preferences/list

/users/roles

Roles

/roles

/roles/list

/roles/privileges

/permission

/permission/add_directory

/permission/remove_directory

Tasks

/tasks

/tasks

/tasks/delete

/tasks/inputs

/tasks/license

/tasks/logs

/tasks/outputs

/tasks/reload

/tasks/report