Azure-docs: Provide full list of possible values for entitity properties

[MarekLani]

Hello, I would like to ask to enrich swagger documentation by all the possible values that can be set for the entity types, resp. it's properties. E.g. when creating Sensor there is need to specify SensorDataType, while swagger provides following documentation for SensorDataType field:
"SensorDataType : defined as category of data the sensor collects, i.e. "Motion", "Temperature", "Humidity", "Sound", "Light", etc." When trying to use custom value, I get error, because apparently SensorDataType value must be from the set of predefined values, but the whole list is not available. So my ask is to change the "etc." word in swagger documentation for the actual full list of possible values, while this relates to many other fields and properties, for which the whole list of possible values is missing. Thank you.

---

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 95664904-5d72-ae8c-1c16-e2b70f108e99
• Version Independent ID: f82753e0-f78c-09fd-2138-5ffd5c6ea7c7
• Content: Understand Digital Twins object models and spatial intelligence graph
• Content Source: articles/digital-twins/concepts-objectmodel-spatialgraph.md
• Service: digital-twins
• GitHub Login: @alinamstanciu
• Microsoft Alias: alinast

[asergaz]

Thanks for the feedback! I have assigned the issue to the content author to evaluate and update as appropriate.

[KingdomOfEnds]

Hi @MarekLani - Thanks for the great suggestion! Existing reference and tutorial documentation is in the process of being improved.

Please call the API endpoint below to bring back a complete list of available Types:

1. https://<YOUR_DIGITAL_TWINS_RESOURCE>.azuresmartspaces.net/management/api/v1.0/types
2. Following the instructions specified here: https://docs.microsoft.com/azure/digital-twins/how-to-configure-postman

To submit a custom Type:

1. Make an authenticated POST to YOUR_MANAGEMENT_API_URL/types.
2. The JSON body should conform to:

{
    "id": 307,
    "category": "SensorDataUnitType",
    "name": "PercentPerHzCommand",
    "disabled": true,
    "logicalOrder": 0,
    "friendlyName": "%/Hz"
}

Two resources that describe the existing Swagger spec (and where you can find more info) include:

• https://docs.microsoft.com/azure/digital-twins/how-to-use-swagger
• https://docs.westcentralus.azuresmartspaces.net/management/swagger/ui/index

Please let me know if there's anything else I can clarify further. Thanks!

[MarekLani]

I have overlooked this API. It is great to have possibility to define custom types. Thank you very much for the guidance @KingdomOfEnds .

[asergaz]

We will now proceed to close this thread. If there are further questions regarding this matter, please tag me in your reply. We will gladly continue the discussion and we will reopen the issue.

[KingdomOfEnds]

@MarekLani - Glad to help! Your suggestions and recommendations have been relayed to other team members. We're reviewing ways to improve the API and documentation going forward. Thanks again!