Partek Flow Documentation

Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

200: application/json
The list of folders

/projects/samples

 

GET

List the samples associated with projects.


Optional parameters

ParameterTypeDescription
project_idsstring

Retrieve specific projects. IDs joined by ,

project_idintegerRetrieve a single project by ID
projectstringRetrieve a single project by name
samplestringList projects that contain a sample with the specified name.
file_namestringList projects that contain a file matching the specified sub-string.
user_idintegerList projects for which the specified user is a member.
user_namestringList projects for which the specified user is a member.

 

Responses
200: application/json
The ID and name for each project that pass the specified filter.  The ID and name for each sample in each project.

Samples

/samples


POST, PUT

Creates a sample.  Returns data for the specified sample.

...

 

Parameter

Type

Description

attribute OR

vocabulary

string

If both vocabulary an attribute and term are specified, then the specified categorical term is applied to the sample

term OR value

string

 

Parameter

Type

Description

numeric_attribute

string

If both an and value are specified, then the specified numeric value is applied to the sample

value

string

 

 

Responses

200: application/json

...

The name, id, files, and attributes of each sample in the project

 

/samples/attributes


GET

Returns the attributes of samples 

 

Required parameters

 

Parameter

Type

Description

project_Id OR

project

integer

string

The ID of the project.

The name of the project.

 

Optional parameters

 

Parameter

Type

Description

sample_Id OR

sample OR

sample_name

integer

string

The ID of the sample.

The name of the sample.

 

Responses

200: application/json

The name, id, and attributes of each sample in the project

Data

/data


POST,PUT

Uploads a file for analysis.

...