Page History

...

Returns data for the specified project.

DELETE

Deletes the specified project.

Required parameters

Parameter	Type	Description
project	string	The name of the project.

...

/projects/list

POST, PUT, GET

Returns the list of visible projects on the server.

Responses

200: application/json

...

{
   "name": "DNA-Seq Project",
   "id": "13",
   "description": "",
   "owner": "0",
   "data": [
     "Variants"
   ]
}

]

/projects/import

POST

Creates a project from the specified zip.

Required parameters

Parameter	Type	Description
filename	string	The name of the file being uploaded.
file	string	The file content

...

500: If an error occurs importing the project

/projects/export

POST, GET

Exports the specified project(s) to a zip.

Required parameters

Parameter	Type	Description
projectIds	string	Project IDs separated by “,” specify "all" to export all projects

...

A zip file containing the project content.

/projects/delete

POST

Deletes the specified project.

Required parameters

Parameter	Type	Description
projectIdsproject	string	Project IDs separated by “,”

...

],
"attributes": {
   "Type": [
     "Normal"
   ],
   "Pair": [
     "1"
   ]
}
}

/samples/list

POST, GET

Returns a list of samples in the specified project.

Required parameters

Parameter	Type	Description
project	string	The name of the project.

...

filepath can be specified instead of filename/file if the data is already on the server.

Optional parameters

Parameter	Type	Description
sample	integer	The id of the sample to add file to. Without this parameter a new sample will be created.
owner	string	The username of the user that should be the owner of the data. The data will count against this user’s quota, if one is configured. By default, the owner will be the user account that uploads the data.
upload_folder	string	If the file is uploaded through the servlet it will be put in this directory, if the owner has permission to access it.

...

Uploads and manages a library file

GET

Returns data about a specified library file

Required parameters

Parameter	Type	Description
file	binary	The file content.
file_type	string	The type of library file: reference_genome
assembly	string	The assembly of the library file

...

400: Returned if any required parameters are missing

GET

Required parameters

Parameter	Type	Description
file_type	string	The type of library file: reference_genome
assembly	string	The assembly of the library file

...

404: Returned if no library file is managed for the specified library file and assembly

/library_files/list

POST, GET

Returns information about library files managed by the server

Required parameters

Parameter	Type	Description
assembly	string	The assembly.

...

Downloads a pipeline specification.

Required parameters

Parameter	Type	Description
pipeline	string	The name of the pipeline

...

404: Returned if the specified pipeline can not be found.

/pipelines/list

POST, GET

Returns a list of pipelines managed by the server

Responses

200: application/json

...

/pipelines/input

POST, GET

Returns the required inputs for a specified pipeline

Required parameters

Parameter	Type	Description
pipeline	string	The name of the pipeline
project	string	The project that the pipeline will run in

...

"hasPendingCommands":"true"

}

/queue/downloads

POST, GET

Returns the count of files being downloaded to the server from servlets and tasks.

Responses

200: application/json

servletDownloads, taskDownloads

/queue/commands

POST, GET

Returns the count of commands that are pending and running.

Responses

200: application/json

pending, running

/queue/tasks

POST, GET

Downloads information about the queued tasks

...

404: Returned if the specified project can not be found.

Example

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

[
{
   "id": 2590,
   "task": "Post-alignment QA\/QC",
   "runStatus": "Pending",
   "progress": 0,
   "submitted": "21 Oct 2016, 03:33 PM CDT",
   "started": "NA",
   "end": "NA"
},
{
   "id": 2589,
   "task": "TMAP - 5.0.0",
   "runStatus": "Running",
   "progress": 5,
   "submitted": "21 Oct 2016, 03:33 PM CDT",
   "started": "21 Oct 2016, 03:33 PM CDT",
   "end": "21 Oct 2016, 03:38 PM CDT"
}
]

Users

/users

POST, PUT

Add and configure a specified user

...

Returns information about all users on the system

Responses

200: application/json

id, name, displayName, isOnline, tasksInQueue, diskQuota, diskUsage (in gigabytes)

Tasks

/tasks

GET

Returns a summary of tasks run on the server

Optional parameters

These parameters filter the task list

Parameter	Type	Description
id	integer	A specific task ID
user_name	string	The name of a user
project	string	The name of a project
status	string	A task status (e.g. Done, Running, Pending)
task	string	The type of task (e.g. Bowtie)

Responses

200: application/json

id, user, project, status, task

Commands

/commands

GET

Returns a summary of commands running on the server.

Optional parameters

These parameters filter the command list

Parameter	Type	Description
task	integer	The ID of a task
workerIdentifier	string	The ID of a worker
successful	boolean	Did the command finish successfully?
commandLine	string	Search for sub-strings within the commandline.

Responses

200: application/json

commandId, workerIdentifier, cpu, memoryMbs, startTimeMillis, runTimeMillis, successful, commandLine

Licensing

/license

POST, GET

Returns a summary of the available licenses.

Optional parameters

These parameters filter the command list

Parameter	Type	Description
feature	string	Query for a specific license feature

Responses

200: application/json

accounts, isNodeLocked, isConcurrent, expiration, version

Workers

/workers

POST, GET

Returns a summary of workers on the server.

Responses

200: application/json

systemIdentifier, workerIdentifier, isInternal, name, commandResourceUsageLimit, systemResourceUsageLimit, timeAtThisStatusInSeconds, responsive, taskIds

/workers/remote

POST, GET

Returns a summary of remote workers on the server.

Responses

200: application/json

systemIdentifier, workerIdentifier, isInternal, name, commandResourceUsageLimit, systemResourceUsageLimit, timeAtThisStatusInSeconds, responsive, taskIds

/workers/internal

POST, GET

Returns a summary of the internal worker.

Responses

200: application/json

systemIdentifier, workerIdentifier, isInternal, name, commandResourceUsageLimit, systemResourceUsageLimit, timeAtThisStatusInSeconds, responsive, taskIds

System

POST, PUT

Configure system parameters

GET

Returns system parameters

Optional parameters

These parameters filter the command list

Parameter	Type	Description
log_level	string	Sets the current log-level: ALL, TRACE, DEBUG, INFO, WARN, ERROR, OFF
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)

Responses

200: application/json

setPageLoadThresholdInSeconds

Additional assistance

Rate Macro

allowUsers	false

...

Partek Flow Documentation

Page tree

Versions Compared

Old Version 7

New Version 8

Key

/projects/list

/projects/import

/projects/export

/projects/delete

/samples/list

/library_files/list

/pipelines/list

/pipelines/input

/queue/downloads

/queue/commands

/queue/tasks

Users

/users

Tasks

/tasks

Commands

/commands

Licensing

/license

Workers

/workers

/workers/remote

/workers/internal

System