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

API Details

Method

POST

URI

/rest/ng/export-jobs/

Payload

Code Block
{ "objectType": "extensions", "params": { "entityType": "Specimen", "formName": "<FORM_NAME>", "cpId": <CP_ID> } }

...

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

E.g.

...

Payloads for different

...

Attribute

Payload

Comments

Participants

Code Block
{ "objectType": "cpr", "params": { "cpId": <CP_ID> } }

Extracts participants data in the CSV file for a given CP id.

Visits

Code Block
{ "objectType": "visit", "params": { "cpId": <CP_ID> } }

Extracts visits data in the CSV file for a given CP id.

Specimens

Code Block
{ "objectType": "specimen", "params": { "cpId": <CP_ID> } }

Extracts specimen data with aliquotes and derivatives in the CSV file for a given CP id.

...