InstanceData

The InstanceData type is used hold information about an instance that can be passed between the UX and APIs.

Below are the properties and their purpose.

• Guid SessionGUID
  • Default Value: Empty Guid.
  • Intended Value: The guid of the current users active session.
• Guid UserGUID
  • Default Value: Empty Guid.
  • Intended Value: The guid of the current user.
• Guid InstanceGUID
  • Default Value: Empty Guid.
  • Intended Value: The guid of the instance.
• string Name
  • Default Value: Empty string.
  • Intended Value: The name of the instance.
• string Status
  • Default Value: Empty string.
  • Intended Value: The status of the instance.
• int LatestVersion
  • Default Value: 0.
  • Intended Value: The latest version of the instance.
• int LoadedVersion
  • Default Value: 0.
  • Intended Value: The version of the instance that is currently loaded.
• int SavedVersion
  • Default Value: 0.
  • Intended Value: Contains the version of the instance the user is trying to save, helpful to catch situations where the instance was updated by someone else and saving would cause a version conflict.
• Guid ParentGUID
  • Default Value: Empty Guid.
  • Intended Value: The guid of the instance that is the parent of this instance.
• string Hierarchy
  • Default Value: Empty string.
  • Intended Value: The full hierarchy for the instance.
• Guid ConceptGUID
  • Default Value: Empty Guid.
  • Intended Value: The guid of the concept that the instance is part of.
• string CreatedBy
  • Default Value: Empty string.
  • Intended Value: The name of the user that created the instance.
• string CreatedOn
  • Default Value: Empty string.
  • Intended Value: The date and time this instance was created.
• Guid InsertedByGUID
  • Default Value: Empty Guid.
  • Intended Value: The guid user that inserted the instance.
• string InsertedOn
  • Default Value: Empty string.
  • Intended Value: The date and time the instance was inserted.
• Guid CorrelationGUID
  • Default Value: Empty Guid.
  • Intended Value: Not currently being used.
• string InsertedBy
  • Default Value: Empty string.
  • Intended Value: The name of the user that inserted the instance.
• int RequiredVersion
  • Default Value: 0.
  • Intended Value: The version of the instance that is required to be loaded.
• string ErrorMessage
  • Default Value: Empty string.
  • Intended Value: Will contain an error message if something went wrong in the API so it can be properly handled in the UX.
• string Data
  • Default Value: Empty string.
  • Intended Value: The string version of the instances instance data XML.
• bool Modified
  • Default Value: false.
  • Intended Value: Currently not being used.
• string ConceptName
  • Default Value: Empty string.
  • Intended Value: The name of the concept the instance belongs to.
• string OldPrimaryKey
  • Default Value: Empty string.
  • Intended Value: Not currently being used.
• XElement XML
  • Default Value: null.
  • Intended Value: Not currently used.
• XElement DeepXML
  • Default Value: null.
  • Intended Value: Not currently used.
• XElement FormXML
  • Default Value: null.
  • Intended Value: Not currently used.