HealthDataRecord (REST Client 0.25.15 API)

java.lang.Object
- org.sagebionetworks.bridge.rest.model.HealthDataRecord

```
@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2022-11-05T00:31:27.098Z")
public class HealthDataRecord
extends Object
```
See [Bridge Upload Data Format](/articles/study_design/upload_data_format.html) for details about this model object. Only researchers and administrators can retrieve this full record through an upload record in the API.

Constructor Summary

Constructors
Constructor and Description

HealthDataRecord()

Constructors
Constructor and Description
`HealthDataRecord()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`String`	`getAppId()` App that this record lives in.
`String`	`getAppVersion()` App version, as reported by the app.
`DateTime`	`getCreatedOn()` ISO timestamp of when the data record was created, as reported by the submitting app
`String`	`getCreatedOnTimeZone()` The original timezone of the createdOn timestamp, expressed as a 4-digit string with sign.
`Object`	`getData()` JSON map with key value pairs representing the record's data.
`Integer`	`getDayInStudy()` How many calendar days the participant has been in the study.
`String`	`getId()` A unique GUID for this record.
`Object`	`getMetadata()` Arbitrary JSON blob of record metadata, as submitted by the app.
`String`	`getPhoneInfo()` Phone info, for example \"iPhone9,3\" or \"iPhone 5c (GSM)\".
`String`	`getRawDataAttachmentId()` Attachment ID (S3 key) that contains the raw data.
`String`	`getSchemaId()` [UploadSchema](#UploadSchema) ID for the record.
`Long`	`getSchemaRevision()` [UploadSchema](#UploadSchema) revision for the record.
`SynapseExporterStatus`	`getSynapseExporterStatus()` Get synapseExporterStatus
`String`	`getType()` HealthDataRecord
`LocalDate`	`getUploadDate()` Calendar date in YYYY-MM-DD format representing when the server received the upload, using the server's local time zone (US Pacific timezone).
`DateTime`	`getUploadedOn()` The date and time of the upload.
`String`	`getUploadId()` The upload GUID of the upload this record is processed from.
`List<String>`	`getUserDataGroups()` The user's data groups at the time of this upload's submission.
`String`	`getUserExternalId()` The user's external ID at the time of this upload's submission.
`Object`	`getUserMetadata()` JSON map with key value pairs representing metadata for this health data record, as submitted by the app.
`SharingScope`	`getUserSharingScope()` The user's sharing scope at the time of this upload's submission.
`Map<String,String>`	`getUserStudyMemberships()` A map where the keys are the study IDs assigned to the user at the time that user generated this health data, and the values are the external IDs that were assigned to the user for each study (if no external ID was assigned, the value will be an empty string).
`String`	`getValidationErrors()` Error messages related to upload validation.
`Long`	`getVersion()` A version number issued for optimistic locking of record updates.
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - HealthDataRecord
```
public HealthDataRecord()
```
- Method Detail
  - getAppVersion
```
public String getAppVersion()
```
    App version, as reported by the app. Generally in the form \"version 1.0.0, build 2\". Must be 48 chars or less.
    
    Returns:
    
    appVersion
  - getCreatedOn
```
public DateTime getCreatedOn()
```
    ISO timestamp of when the data record was created, as reported by the submitting app
    
    Returns:
    
    createdOn
  - getCreatedOnTimeZone
```
public String getCreatedOnTimeZone()
```
    The original timezone of the createdOn timestamp, expressed as a 4-digit string with sign. For example, -0800, +0900
    
    Returns:
    
    createdOnTimeZone
  - getData
```
public Object getData()
```
    JSON map with key value pairs representing the record's data.
    
    Returns:
    
    data
  - getDayInStudy
```
public Integer getDayInStudy()
```
    How many calendar days the participant has been in the study. For example, if the participant started on | 2019-07-24, then 2019-07-24 is day 1, 2019-07-25 is day 2, etc. Calendar days are calculated using the | same timezone as the Bridge Exporter (ie, America/Los_Angeles).
    
    Returns:
    
    dayInStudy
  - getId
```
public String getId()
```
    A unique GUID for this record.
    
    Returns:
    
    id
  - getMetadata
```
public Object getMetadata()
```
    Arbitrary JSON blob of record metadata, as submitted by the app. For ResearchKit-based apps, this is info.json verbatim.
    
    Returns:
    
    metadata
  - getPhoneInfo
```
public String getPhoneInfo()
```
    Phone info, for example \"iPhone9,3\" or \"iPhone 5c (GSM)\". Must be 48 chars or less.
    
    Returns:
    
    phoneInfo
  - getRawDataAttachmentId
```
public String getRawDataAttachmentId()
```
    Attachment ID (S3 key) that contains the raw data. This is the unencrypted zip file for uploads, or JSON blob for directly submitted records
    
    Returns:
    
    rawDataAttachmentId
  - getSchemaId
```
public String getSchemaId()
```
    [UploadSchema](#UploadSchema) ID for the record.
    
    Returns:
    
    schemaId
  - getSchemaRevision
```
public Long getSchemaRevision()
```
    [UploadSchema](#UploadSchema) revision for the record.
    
    Returns:
    
    schemaRevision
  - getAppId
```
public String getAppId()
```
    App that this record lives in.
    
    Returns:
    
    appId
  - getUploadDate
```
public LocalDate getUploadDate()
```
    Calendar date in YYYY-MM-DD format representing when the server received the upload, using the server's local time zone (US Pacific timezone).
    
    Returns:
    
    uploadDate
  - getUploadId
```
public String getUploadId()
```
    The upload GUID of the upload this record is processed from.
    
    Returns:
    
    uploadId
  - getUploadedOn
```
public DateTime getUploadedOn()
```
    The date and time of the upload.
    
    Returns:
    
    uploadedOn
  - getUserMetadata
```
public Object getUserMetadata()
```
    JSON map with key value pairs representing metadata for this health data record, as submitted by the app. This corresponds with the uploadMetadataFieldDefinitions configured in the study.
    
    Returns:
    
    userMetadata
  - getUserSharingScope
```
public SharingScope getUserSharingScope()
```
    The user's sharing scope at the time of this upload's submission.
    
    Returns:
    
    userSharingScope
  - getUserExternalId
```
public String getUserExternalId()
```
    The user's external ID at the time of this upload's submission.
    
    Returns:
    
    userExternalId
  - getUserDataGroups
```
public List<String> getUserDataGroups()
```
    The user's data groups at the time of this upload's submission.
    
    Returns:
    
    userDataGroups
  - getUserStudyMemberships
```
public Map<String,String> getUserStudyMemberships()
```
    A map where the keys are the study IDs assigned to the user at the time that user generated this health data, and the values are the external IDs that were assigned to the user for each study (if no external ID was assigned, the value will be an empty string).
    
    Returns:
    
    userStudyMemberships
  - getValidationErrors
```
public String getValidationErrors()
```
    Error messages related to upload validation. Only generated if UploadValidationStrictness is set to REPORT.
    
    Returns:
    
    validationErrors
  - getVersion
```
public Long getVersion()
```
    A version number issued for optimistic locking of record updates. Should not be set when creating a new health data record. When updating a record retrieved from the API, the object will have the version attribute and this must match the last value issued by the service or an update will fail.
    
    Returns:
    
    version
  - getSynapseExporterStatus
```
public SynapseExporterStatus getSynapseExporterStatus()
```
    Get synapseExporterStatus
    
    Returns:
    
    synapseExporterStatus
  - getType
```
public String getType()
```
    HealthDataRecord
    
    Returns:
    
    type
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class HealthDataRecord

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HealthDataRecord

Method Detail

getAppVersion

getCreatedOn

getCreatedOnTimeZone

getData

getDayInStudy

getId

getMetadata

getPhoneInfo

getRawDataAttachmentId

getSchemaId

getSchemaRevision

getAppId

getUploadDate

getUploadId

getUploadedOn

getUserMetadata

getUserSharingScope

getUserExternalId

getUserDataGroups

getUserStudyMemberships

getValidationErrors

getVersion

getSynapseExporterStatus

getType

equals

hashCode

toString