Skip to content

Commit b89eae5

Browse files
committed
Untyped
1 parent 4ab36f8 commit b89eae5

1 file changed

Lines changed: 15 additions & 11 deletions

File tree

  • content/en/docs/apidocs-mxsdk/apidocs/studio-pro-10/extensibility-api/csharp/extensibility-api-howtos

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-10/extensibility-api/csharp/extensibility-api-howtos/untyped-model-api.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,31 +7,35 @@ weight: 24
77

88
## Introduction
99

10-
The Untyped Model Access API caters to the advanced users who are familiar with the internals of the Mendix platform. With the Untyped Model API, you can access the rich data of model elements.
10+
The Untyped Model Access API is designed for advanced users familiar with the internals of the Mendix platform. It allows access to the rich data of model elements.
1111

12-
When you need to use model elements, units, and property names in the Untyped Model API, you can reference the [Mendix Model SDK](https://apidocs.rnd.mendix.com/modelsdk/latest/index.html). Moreover, you can find the type names used by the Untyped Model Access API under the [structureTypeName](https://apidocs.rnd.mendix.com/modelsdk/latest/classes/Structure.html#structureTypeName) property of any model element.
12+
* For model elements, units, and property names, see the [Mendix Model SDK](https://apidocs.rnd.mendix.com/modelsdk/latest/index.html).
13+
* Type names used by the Untyped Model Access API are available under the [structureTypeName](https://apidocs.rnd.mendix.com/modelsdk/latest/classes/Structure.html#structureTypeName) property of any model element.
1314

1415
{{% alert color="info" %}}
15-
All methods provided by the Untyped Model API are recursive to reduce the amount of API calls necessary to get to the content you are looking for.
16+
All methods in the Untyped Model API are recursive to reduce the amount of API calls necessary to retrieve content.
1617
{{% /alert %}}
1718

1819
## Prerequisites
1920

20-
To see the Untyped Model API in action, as described in the examples in this document, you must create a microflow having the default name `MyFirstLogic` with an action, and add an entity to the domain model.
21+
Before using the examples in this how-to:
22+
23+
* Create a microflow named `MyFirstLogic` with an action
24+
* Add an entity to the domain model
2125

2226
## Getting Started
2327

24-
To start using the Untyped Model API, import it:
28+
Begin by importing the Untyped Model Access API service:
2529

2630
```csharp
2731
class Sample(IUntypedModelAccessService untypedModelAccessService)
2832
{
2933
}
3034
```
3135

32-
## Gaining Access to the Model Root
36+
## Access the Model Root
3337

34-
To gain access to the model `Root`, request it from the newly added API service:
38+
Use the Untyped Model Access AP to gain access to the model `Root`:
3539

3640
```csharp
3741
class Sample2(IUntypedModelAccessService untypedModelAccessService, IModel currentApp)
@@ -43,7 +47,7 @@ class Sample2(IUntypedModelAccessService untypedModelAccessService, IModel curre
4347

4448
## Requesting Top-level Model Elements
4549

46-
To start going through the model elements, such as `Apps` and `Modules`, choose a starting point first:
50+
To access the model elements, such as `Apps` and `Modules`, choose a starting point:
4751

4852
```csharp
4953
class Sample3(IUntypedModelAccessService untypedModelAccessService, IModel currentApp)
@@ -62,9 +66,9 @@ class Sample3(IUntypedModelAccessService untypedModelAccessService, IModel curre
6266

6367
## Accessing Child Elements
6468

65-
It is possible to access the child elements of a model element, such as the actions of a microflow or entities of a domain model.
69+
You can access the child elements of a model element, such as microflow actions or entities of a domain model.
6670

67-
Using either `GetElements` or `GetElementsOfType`, can help you, for example, analyze these elements' properties to implement custom validation rules. See an example below:
71+
Use `GetElements` or `GetElementsOfType` to analyze the element properties and implement custom validation rules.
6872

6973
```csharp
7074
class Sample4(IUntypedModelAccessService untypedModelAccessService, IModel currentApp)
@@ -88,7 +92,7 @@ class Sample4(IUntypedModelAccessService untypedModelAccessService, IModel curre
8892

8993
## Getting Model Unit's Properties
9094

91-
In case you would like to extract data out of a model element or unit, you need to access its properties. See an example below:
95+
To extract data out of a model element or unit, access its properties:
9296

9397
```csharp
9498
class Sample5(IUntypedModelAccessService untypedModelAccessService, IModel currentApp)

0 commit comments

Comments
 (0)