Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support propertyAlias to fetch data #98

Closed
tracy-french opened this issue Jul 7, 2021 · 5 comments · Fixed by #99
Closed

Support propertyAlias to fetch data #98

tracy-french opened this issue Jul 7, 2021 · 5 comments · Fixed by #99

Comments

@tracy-french
Copy link
Collaborator

SiteWise GET APIs for fetching SiteWise data (i.e. https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_GetAssetPropertyValueHistory.html) support propertyAlias as an alternative to using assetId + propertyId.

@atifali
Copy link
Contributor

atifali commented Jul 15, 2021

how do we get the assetProperty description from just using the propertyAlias?

looks like we do need the propertyId for this to work:
https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetProperty.html

currently all responses use the assetProperty description to properly format the query results to frames.

@tracfren suggestions?

@macrovve
Copy link
Contributor

There is no way to get propertyId by alias from the API.
May I ask why do you need the property id?

@atifali
Copy link
Contributor

atifali commented Aug 4, 2021

well we need the assetProperty description to set the dataType for conversion to frames. see: #99 (comment)

and it looks like currently the SiteWise API only supports DescribeAssetProperty with both assetId and propertyId as params. is there a way to run DescribeAssetProperty with propertyAlias as the only param? seems like a useful thing to have, since most other queries also have that option

for now i believe we can extract the dataType from the returned data, but we would still need to be able to get to the rest of the info in the struct iotsitewise.DescribeAssetPropertyOutput to be consistent with the case of querying with assetId + propertyId

@macrovve
Copy link
Contributor

macrovve commented Aug 6, 2021 via email

@atifali
Copy link
Contributor

atifali commented Aug 6, 2021

for now we have implemented some ad-hoc dataType inference:
#99 (comment)

but i do still think having the functionality in the api i mentioned would go far and be very useful. keep us updated on that 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants