Versions Compared

Key

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

...

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.

...

Parameter
Details
appData

data required to identify the form.

ParameterDetails
formCtxtIdThis is the identifier of the event form context, for which the user wants to make data entry. This is the system generated identifier for the event form . Please refer here on how to get the formId.context. 
objectIdThe identifier of the Specimen for which user wants to make data entry.
userId of the user, who is performing this event
timeevent time stamp
commentsExtra information which user wants to store with event creation.
other fieldsHere comes all the event specific fields, like neoPlasticCellularityPct in case of Tissue Review Event.

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

...