Versions Compared

Old Version 4

changes.mady.by.user Kaustubh Wadagavi

Saved on

compared with

New Version Current

changes.mady.by.user Kaustubh Wadagavi

Saved on

Key

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

...

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 at the end of the pagein the below.

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

...

attributes of CP

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.

...