Task #13139

Task #13068: PerformFISH Analytical Toolkit Service

Performance interface - Perform service

Added by Fabio Sinibaldi about 1 year ago. Updated 7 months ago.

Status:ClosedStart date:Jan 14, 2019
Priority:NormalDue date:
Assignee:Fabio Sinibaldi% Done:

100%

Category:application
Sprint:zz - PerformFish Service
Milestones:
Duration:

Description

This ticket tracks the activity regarding the develop of Mappings interface.

Expected Methods are :

Get deanonimized dataset :
input = dataset filters, farmid list
output = csv file

History

#1 Updated by Fabio Sinibaldi about 1 year ago

  • % Done changed from 0 to 90
  • Status changed from New to In Progress

Interface specifications :
BasePath = 'performance'

Batch method specifications :
HTTP method = GET
Query Parameter 'farmid' mandatory
Query Parameter 'batch_type' mandatory
Query Parameter 'area'
Query Parameter 'period'
Query Parameter 'quarter'
Query Parameter 'speciesid'

All parameters except "batch_type" can be specified multiple times and will be considered as OR group in filtering selection.

Response is a Map Description -> Storage ID serialized as JSON

#2 Updated by Fabio Sinibaldi about 1 year ago

Example of JSON output :

{"BatchesTable":"aslfgurt-dfgumk374","AntiparasiticTable":"aslfgurt-dfjfuutjhr3648925"}

#3 Updated by Fabio Sinibaldi about 1 year ago

Requirement change :
the resulting JSON Map will be Description -> public url

#4 Updated by Fabio Sinibaldi 12 months ago

  • % Done changed from 90 to 100
  • Status changed from In Progress to Feedback

Requirement change :
for each exported CSV, an additional CSV is generated reporting filtered de-anonymized entries found in the same CSV.
This additional CSV will have the same Key in the resulting map, plus the suffix "_internal".

At the moment the additional CSV is expected to contain one field, but the service can be configured for different cases.

Following are two example of JSON output:

#5 Updated by Fabio Sinibaldi 12 months ago

After receiving more details in #13037, the resulting additional CSVs will have more than one field and the gui will be supposed to show a different field according to analysis configurations.

In particular, fieldnames will be constants (but their presence in the CSV will depend on service configuration) and they will be : "BATCH", "FARM", "AREA".

If more fields will be required, additional constant labels will be agreed between service and GUI.

Following is a complete output of this interface method :
~~~
{"BatchesTable_internal":"http://data-d.d4science.org/V3MrMnNCRUllaGhDWWVKenFpNGtJa0VFejBVSU9SNU9HbWJQNStIS0N6Yz0-VLT",
"LethalIncidentsTable_internal":"http://data-d.d4science.org/MFBJVk10NHNMQWRDWWVKenFpNGtJblM3andGcUtwUU5HbWJQNStIS0N6Yz0-VLT",
"AntibioticsTable_internal":"http://data-d.d4science.org/V3MrMnNCRUllaGhDWWVKenFpNGtJdk4zQ3RQZkZFTTFHbWJQNStIS0N6Yz0-VLT",
"LethalIncidentsTable":"http://data-d.d4science.org/MFBJVk10NHNMQWRDWWVKenFpNGtJc01QWUYyQlBQZFlHbWJQNStIS0N6Yz0-VLT",
"AntibioticsTable":"http://data-d.d4science.org/V3MrMnNCRUllaGhDWWVKenFpNGtJbFpOWXZnay8yWWZHbWJQNStIS0N6Yz0-VLT",
"AnnualTable_internal":"http://data-d.d4science.org/MFBJVk10NHNMQWRDWWVKenFpNGtJaDBBUHB5WERSc0RHbWJQNStIS0N6Yz0-VLT",
"AnnualTable":"http://data-d.d4science.org/MFBJVk10NHNMQWRDWWVKenFpNGtJdHFVSkUvRlpRaG9HbWJQNStIS0N6Yz0-VLT",
"BatchesTable":"http://data-d.d4science.org/V3MrMnNCRUllaGhDWWVKenFpNGtJbXNtNUFNZmYvSWxHbWJQNStIS0N6Yz0-VLT",
"AntiparasiticTable":"http://data-d.d4science.org/dzNVVmFPVTRUWFpDWWVKenFpNGtJdkoxZlZoc2Z2ZVJHbWJQNStIS0N6Yz0-VLT",
"AntiparasiticTable_internal":"http://data-d.d4science.org/dzNVVmFPVTRUWFpDWWVKenFpNGtJdGx4YSswYXFsUjlHbWJQNStIS0N6Yz0-VLT"}
~~~

#6 Updated by Fabio Sinibaldi 7 months ago

  • Status changed from Feedback to Closed

Also available in: Atom PDF