1 API Details
- 1.1 Parameter Details
- 1.2 Request Payload:-
- 1.3 Response Payload
2 Exporting data in the file
3 Payloads for different attributes of CP
4 Error Cases :

we can extract all CP data like participants, visits, specimens....etc.

The request methods and URLs are the same for all attributes. Just need to change the request payloads. The request payloads for different CP attributes are mentioned in the below.

An example of extracting specimen forms data using API is given below.

API Details

Method	`POST`
URI	`/rest/ng/export-jobs/`
Payload	`{ "objectType": "extensions", "params": { "entityType": "Specimen", "formName": "<FORM_NAME>", "cpId": <CP_ID> } }`

Parameter Details

`formName`	Name of the form that you want to export the data.
`cpId`	Collection protocol ID.

Request Payload:-

{
    "objectType": "extensions", 
    "params": 
    { 
        "entityType": "Specimen", 
        "formName": "techSpecimenForm", 
        "cpId": 3513
    }
}

Response Payload

{
    "id": 4878,
    "name": "extensions",
    "status": "COMPLETED",
    "totalRecords": null,
    "createdBy": {
        "id": 5413,
        "type": "SUPER",
        "firstName": "System",
        "lastName": "Administrator",
        "loginName": "admin",
        "domain": "openspecimen",
        "emailAddress": "admin@localhost",
        "instituteId": 1,
        "instituteName": "Biobank Institute",
        "primarySite": "Biobank_Site_1",
        "admin": true,
        "instituteAdmin": false,
        "manageForms": true,
        "cpCount": 0,
        "creationDate": 1608625532000,
        "activityStatus": "Active"
    },
    "creationTime": 1633773235491,
    "endTime": 1633773235535,
    "params": {
        "timeZone": "Asia/Kolkata",
        "entityType": "Specimen",
        "cpId": "3513",
        "formName": "techSpecimenForm"
    }
}

Exporting data in the file

Enter the id from the above response in the below URL. Send the request. Save response in the file.

Method	`GET`
URI	`/rest/ng/export-jobs/<JOB_ID/output`

E.g.

Payloads for different attributes of CP

Attribute	Payload	Comments

Attribute	Payload	Comments
Participants		Extracts participants data in the CSV file for a given CP id.
Visits		Extracts visits data in the CSV file for a given CP id.
Specimens		Extracts specimen data with aliquotes and derivatives in the CSV file for a given CP id.

Error Cases :

code	Applies to	Status Message

code	Applies to	Status Message
200	All resources	Data exported successfully.
400	All requests	Invalid parameters.(Invalid form name, CP_ID, JOB_ID etc)
401	All requests	Authorization failed, user doesn't have Authority
500	All requests	Internal server error, Encountered server error while performing operations

OpenSpecimen

How to export the CP data using API