Versions Compared

Key

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

...

Table of Contents

metadata.json

Flat map of key-value pairs representing upload metadata.

Fields

  • startDate & endDate - ISO8601 timestamps for when the assessment was started and finished on the participant’s device

  • deviceInfo - Describes the participant’s device

Open Questions:

  • Can you confirm the existence and format of the fields listed above?

  • Are there any other keys that must be present in this file? Or is this just freeform key-value pairs?

  • Is this redundant with the metadata submitted in the Upload API as documented in https://developer.sagebridge.org/articles/data/bundled_zip_file_uploads.html#call-the-upload-request-api? Are there fields in this file that are specifically expected to not be part of the Synapse annotations?

    • Note that because these aren’t part of Synapse annotations, researchers will not be able to add these fields to a view and query on them.

assessmentResult.json

Open Questions:

  • Not sure what this is. Is this survey-specific? Assessment-specific? Do we expect all assessments to submit a file called assessmentResult.json?

  • If validation is keyed off of filename, does this mean all assessmentResult.json will have the same schema? Or will we need assessment-specific schemas for this?

data.json

This is the result file for an Arc assessment. Schema is defined in the metadata.json file but is different depending upon the assessment.

answers.json

Flat map of key-value pairs, used for generating the CSV.

Open Questions:

...

Every upload will have a metadata.json. This includes a manifest of all files (documented in https://github.com/BridgeDigitalHealth/mobile-client-json/pull/17), as well as other key-value pairs (documented in the schema https://github.com/BridgeDigitalHealth/mobile-client-json/blob/main/schemas/v2/ArchiveMetadata.json).

  • appName (string) - Name of the app that built the archive.

  • appVersion (string) - Version of the app that built the archive.

  • deviceInfo (string) - Information about the specific device.

  • deviceTypeIdentifier (string) - Specific model identifier of the device.

  • files (array) - A list of the files included in this archive.