Releases: HiberGlobal/api
Releases · HiberGlobal/api
0.208.0
0.208 (2024-09-10)
ExportService
- Added
Export.Configuration.AssetValues
(andExport.Configuration.asset_values
) to export values for assets.- This exports
ValueContext
s for the givenAsset
s in the givenTimeRange
. - Added
AvailableFieldsForExport.Request.asset_values
to get available fields for assets to export.
- This exports
FieldService
- Added
ListFieldsForAsset.Request.include_historic_fields
to include fields that were available to the asset
in the past (from devices assigned to it in the past).
ValueService
- Added
asset_identifier
toValueContext
as the shared owner of the value (optional) and
additional asset information, likeasset_name
andasset_type
, for convenience.- This and other assets own the value, while the value is produced by a device assigned to it.
- Removed
assets
, since it does not reflect the reality of how we want to use the data.- Removed
ValueContext.ValueAssetContext
since it is no longer needed.
- Removed
- Added convenience fields to
Value.Numeric
:- Added
value
toValue.Numeric
to get the numeric value regardless of theType
.- The typed values still contain the value in the actual type (i.e. pressure)
- Renamed the
value
oneof
totyped_value
for clarity.
- Added
textual
toValue.Numeric
to get the textual value regardless of theType
. - Added
unit
ofUnitOfMeasurement
toValue.Numeric
to get the textual value regardless of theType
.- Note that this
UnitOfMeasurement
contains all possible units, and is different from the specific unit types:- For example:
UnitOfMeasurement.PRESSURE_PSI
versusValue.Numeric.Pressure.Unit.PSI
which only
contains pressure units.
- For example:
- Note that this
- Added
- Marked all
converted_from
fields inValue.Numeric.*
types as optional, since they would otherwise
default to the firstUnit
value.
ValueSimulationService
- Added
unit
andtype
toValueSimulation.ValueRotation.Numeric
to specify what is being simulated.
ValueService
- Added
ValueSelection.data_selection
to select the type of values to get:- Added
field
in thedata_selection
oneof
to list values for a given (set of) field(s).- Deprecated the
fields
in the selection, because arepeated
field cannot be used in aoneof
.
- Deprecated the
- Added
numeric_value_type
to list values with a specificValue.Numeric.Type
.- Note that downsampling is done per
Value.Numeric.Type
when multiple are specified.
- Note that downsampling is done per
- When no
ValueSelection.data_selection
is made:ValueService.List
will return all values.ValueService.Downsampled
will apply to all values byValue.Numeric.Type
.- Values without a known
Value.Numeric.Type
will not be included.
- Values without a known
ValueService.Aggregated
does not currently supportnumeric_value_type
, this will be added in the future.
- Added
ValueService
- Added pressure unit
kg/cm²
.
0.207.0
0.207 (2024-09-03)
TokenService
- Added
Token.last_used
with the date the token was last used. - Added
Token.used_for_this_call
to show that this token was used to make the call that resulted in this list of tokens.
TagService
- Added
ListTagsRequest.asset_count
to count the assets for the listed tags.- Added
ListTagsRequest.Response.tag_asset_count
for the result.
- Added
AssetService
- Added
Asset.AssignedDevice.health
to see the health of assigned device(s).
ValueService
- Removed the
repeated
flag onValueContext.assets
and renamed the field toasset
.- Values with multiple assets will be repeated instead.
0.204.0
0.204 (2024-08-06)
AssetService
- Added extra information to
Asset.AssignedDevice
:last_message_sent_at
andlast_message_received_at
assignment_time_range
- Added
Asset.inactive_devices
to list previously assigned devices.
These have less information available than a currently assigned device, but ues the same object type.
0.203.0
0.203 (2024-07-30)
AssignmentService
- Added device to asset assignment in addition to asset to device. They are essentially the same and will be output in the default asset to device format.
- Added
Assignment.to_asset
,Assign.Request.to_asset
andUnassign.Request.from_asset
to support the device to asset assignment.
- Added
CertificateService
- Marked
ca_certificate_name
andca_certificate_id
inCertificate
as optional.
MQTTService
- We now enforce the use of
mqtts://
for new MQTT integrations.- Added
override_url_validation
toCreateMQTTPublisherRequest
andUpdateMQTTPublisherRequest
override this if necessary.
- Added
0.198.0
0.198 (2024-06-25)
AssetService
- Added
ListAsset.Request.child_organizations
to list assets in child organizations.- Added
Asset.organization
to show the owner organization of an asset.
- Added
UserService
- Added
UserValidation.require_verified_email_addresses
and
UpdateUserValidationRequest.require_verified_email_addresses
to require all users to have verified
their email address in your organization. - A few changes to sign-in restrictions:
- Added
UpdateUserValidationRequest.allow_all_sign_in_providers
to remove sign-in provider restrictions. - When
UserValidation.allowed_sign_in_providers
does not allow theSignInProvider.PASSWORD
sign-in method,
creating users will not be allowed.
- Added
ModemService
- Added
Modem.Lifecycle.SPARE
.
0.197.0
0.197 (2024-06-18)
CurrentUserService
- Fixed a bug where
CurrentUser
would return an inaccessible default organization when using a token from a child organization. - Adjusted
CurrentUser
to allow it to be used with a token withUserPermission.READ
by limiting the data returned, but still returning permissions and roles.
0.196.1
0.196 (2024-06-11)
UserService
- Added
UserValidation.allowed_sign_in_providers
to limit the sign in providers for an organization.- Added
UserValidation.SignInProvider
list of supported sign in providers.- If any new providers would be added, and a limitation is in place, they are excluded by default.
- Added
0.195.1
0.195 (2024-06-04)
FieldService
- Added
ForAsset
to list the fields for an asset.
ValueService
- Added
assets
toValueSelection
, in aoneof
, so a selection selects either assets or devices.- Renamed
modems
todevices
.
- Renamed
- Added
assets
toValueContext
for values for assets. - Renamed
modem
todevice
inValueContext
. - Marked
AggregatedValues.location
optional instead of deprecated.
AssignmentService
- Removed the option for future time values for assignment, since it has unintended consequences.
AssetService
- Removed the option for future time values for assignment, since it has unintended consequences.
0.192.0
0.192 (2024-05-14)
AssignmentService
- Added
override_time
andschedule_end_time
toAssign.Request
to customize the assignment time. - Added
override_time
toUnassign.Request
to customize the unassignment time. - Added
include_inactive_assignments
toListAssignments.Request
to list inactive assignments.- Assignments that no longer have an effect while inactive may be removed automatically.
0.191.0
0.191 (2024-04-30)
AssetService
- Introducing
Asset
s as the conceptual counterpart of the devices.- Assets are abstractions managed by the customer and linked to devices.
- Assets will own data (values) produced by devices, but when a device is replaced, the asset's values will just
continue with the data from the new device. - Assets have type for common use cases (currently well-related Annulus A/B/C/D and tubing head pressure).
- Asset are not limited to the predefined types, they can be anything that is required to collect data
into one place.
- Asset are not limited to the predefined types, they can be anything that is required to collect data
- Assets will get SLA configuration and calculate SLAs.
- We will phase out SLA configuration on devices slowly.
base.proto
- Deprecated the
Update*
types in favor of usingoptional
fields.- Deprecated
UpdateZeroableInt
. - Deprecated
UpdateClearableString
. - Deprecated
UpdateOptionalId
. - Deprecated
UpdateOptionalDuration
. - Deprecated
UpdateBoolean
. - Deprecated
Filter.ChildOrganizations.Update
. - Deprecated
Filter.Events.Update
. - Deprecated
Filter.Modems.Update
. - Deprecated
Filter.Tags.Update
. - Deprecated
BytesOrHex.Update
. - Updated a lot of services to use
optional
instead ofUpdate*
types.
- Deprecated
Organization Permissions
- Split the
MODEMS_ALARMS
permission to manage alarms into a view permissionMODEMS_ALARMS
and manage permissionMODEMS_ALARMS_UPDATE
.- Roles have been updated to keep effective permissions consistent, but new roles will have more granularity.