Page Comparison

Specimen events in OpenSpecimen are modeled using DE forms. To create specimen event, please use DE form data save API as explained below:

Use this resource to make data entry for specimen event in the openSpecimen application. Use HTTP POST method to call this API by passing the below details in JSON format. Here formId is the identifier of the event form for which user wants to perform the data entry.

Below are the attributes which need to be sent in the request body:

NOTE:
To get the formId and formCtxId, execute the below SQL query:

select c.name as formName, c.identifier as formId, ctx.identifier as formCtxId, ctx.entity_type as level, cp.title as CP from dyextn_containers c  inner join catissue_form_context ctx on ctx.container_id = c.identifier left join catissue_collection_protocol cp on cp.identifier = ctx.cp_id where   c.name = '<form name>'

Here <form name> is the name of the form for which user wants to make data entry. e.g. for Specimen Collection Event the name is "SpecimenCollectionEvent".

http[s]:<host>:<port>/openspecimen/rest/ng/forms/{formId}/data

Use this URL to make data entry for specimen event in openSpecimen application.

Result:

The response of this request will contains the details of the created participant.

Below is the example of the create Cell Review Event event:

Example of request JSON (Cell Review Event)

{
  "appData":{
     "formCtxtId": 6,
     "objectId": 11632,
     "useUdn": true
  },
  "neoPlasticCellularityPct": "21",
  "viableCellPct": "12",
  "user": 1,
  "time": "10-29-2014 1:15",
  "comments": ""
}

Example of response JSON

"{
  \"id\":14313,

...

  \"time\":\"10-29-2014 1:15\",

...

  \"appData\":{
    \"formCtxtId\":6.0,
    \"objectId\":11632.0
  },

...

  \"neoPlasticCellularityPct\":\"21\",

...

  \"user\":1.0,

...

  \"viableCellPct\":\"12\",

...

  \"containerId\":6,

...

  \"comments\":\"\"
}"

Download the sample Java client from here.

NOTE: Error Cases :

To get the formId and formCtxId, execute the below SQL query:

select 
  c.name as formName, c.identifier as formId, ctx.identifier as formCtxId, ctx.entity_type as level, cp.title as cp 
from 
  dyextn_containers c  
  inner join catissue_form_context ctx on ctx.container_id = c.identifier 
  left join catissue_collection_protocol cp on cp.identifier = ctx.cp_id 
where   
  c.caption = '<form display name>'

In above SQL form display name refers to caption that user sees in Manage Forms or form data entry view

An alternative to using SQL is using below APIs 

• List forms available for data entry
  
  

  Code Block
  GET openspecimen/rest/ng/forms

• List associations of form
  
  

  Code Block
  GET openspecimen/rest/ng/forms/{formId}/contexts

Error codes

...