Query parameter and record

Get all records

GET http://try-server.labpipe.org/api/query/record/all/:sid

Path Parameters

Name	Type	Description
sid	string	Study identifier

Headers

Name	Type	Description
Authorization	string	HTTP Basic authentication

200

[{
    "form_code": "test",
    "study_code": "EMBER",
    "instrument_code": "PTR",
    "p_visit_type": {
        "visit_type": true
    },
    "p_basic": {
        "participant_id_prefix": "AAA",
        "participant_id_number": "1234",
        "participant_id": "AAA-1234"
    },
    "p_file": {
        "file": [
            "/data/[email protected]"
        ]
    },
    "uploaded_by": "bo.zhao",
    "created": "2019-07-10T12:51:07.149980"
}]

Get all studies

GET http://try-server.labpipe.org/api/query/study/all

Headers

Name	Type	Description
Authorization	string	HTTP Basic authentication

200

[{ 
    "name" : "Example Study", 
    "config" : {
        "participant_id" : {
            "prefix" : [
                "EX", 
                "ES"
            ], 
            "length" : 3
        }, 
        "visit_id" : [
            "0", 
            "4", 
            "7", 
            "10", 
            "13", 
            "14"
        ], 
        "location" : [
            "GGH"
        ], 
        "instrument" : [
            "PTR", 
            "R"
        ]
    }, 
    "identifier" : "EXS"
}]

Get study by identifier

GET http://try-server.labpipe.org/api/query/study/one

Query Parameters

Name	Type	Description
identifier	string	Study identifier

Headers

Name	Type	Description
Authorization	string	HTTP Basic authentication

200

{ 
    "name" : "Example Study", 
    "config" : {
        "participant_id" : {
            "prefix" : [
                "EX", 
                "ES"
            ], 
            "length" : 3
        }, 
        "visit_id" : [
            "0", 
            "4", 
            "7", 
            "10", 
            "13", 
            "14"
        ], 
        "location" : [
            "GGH"
        ], 
        "instrument" : [
            "PTR", 
            "R"
        ]
    }, 
    "identifier" : "EXS"
}

500

{"message" : "Study not exists with given identifier"}

Get all instruments

GET http://try-server.labpipe.org/api/query/instrument/all

Headers

Name	Type	Description
Authorization	string	HTTP Basic authentication

200

[{ 
    "name" : "PTR-MS", 
    "realtime" : true, 
    "identifier" : "PTR", 
    "fileType" : [
        "lst", 
        "ini"
    ]
}]

Get instrument by identifier

GET http://try-server.labpipe.org/api/query/instrument/one

Query Parameters

Name	Type	Description
identifier	string	Instrument identifier

Headers

Name	Type	Description
Authorization	string	HTTP Basic authentication

200

{ 
    "name" : "PTR-MS", 
    "realtime" : true, 
    "identifier" : "PTR", 
    "fileType" : [
        "lst", 
        "ini"
    ]
}

500

{"message": "Instrument not exists with given identifier"}