Partek Flow Documentation

Page tree

Versions Compared

Key

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

...

 

Parameter

Type

Description

attribute OR

vocabulary

string

If both 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

 

Parameter

Type

Description

attribute_json

string

A specification in the same format as /samples/attributes, for example:

Code Block
[
  {
    "name": "sample1",
    "id": 0,
    "attributeValue": {
      "Type": "Case",
      "Gender": "M"
    },
    "numericAttributeValue": {
      "Age":0 
    }
  },
  {
    "name": "sample2",
    "id": 1,
    "attributeValue": {
      "Type": "Control",
      "Gender": "F"
    },
    "numericAttributeValue": {
      "Age":10
    }
  }
]

Samples can be specified by name or id and both attributeValue and numericAttributeValue are optional

The AddAttribute.py script will read the content from a specified file.

 

 

 

Responses

200: application/json

...

404: Returned if there is no project with the given id or if a sample with the specified name can not be found

 

Example

...

/

...

samples

...

{

 "name": "Sample1",
 "id": "0",
 "files": [

    "FastqFileDataType: 14138"

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

 

/samples/list


POST, GET

Returns a list of samples in the specified project.

...