Got feedback or spotted a mistake?

Leave a comment at the end of this page or email contact@krishagni.com

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

We can export specimen form data using APIs.

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.

Example -

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": "Kaustubh",
        "lastName": "Wadagavi",
        "loginName": "kaustubh",
        "domain": "openspecimen",
        "emailAddress": "kaustubh@krishagni.com",
        "instituteId": 2863,
        "instituteName": "Kaustubh Institute",
        "primarySite": "Kaustubh_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"
    }
}

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

Method

GET

URI

/rest/ng/export-jobs/4878/output

E.g.

  • No labels