## On this page

  

 

 # Class RequestAPI

 Last update: 16.07.2025 

Namespace: [VM.API.Pre](VM.API.Pre.md)  
Assembly: VM.API.Pre.dll

This class implements APIs for request class.

```csharp
public static class RequestAPI

```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ← [RequestAPI](VM.API.Pre.RequestAPI.md)

#### Extension Methods

[LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkProperties_System_Object_VM_Models_Pre_LinkPropertyType_), [LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkPropertiesAndValues_System_Object_VM_Models_Pre_LinkPropertyType_), [LinkPropertyItemCache.GetLinkedObjects<T>(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkedObjects__1_System_Object_VM_Models_Pre_LinkPropertyType_)

## Methods

### CreateConnectedEntityRequest(SubSystemDocument, Obj, string)

```csharp
[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "actionEntity" })]
[MatchTypeObj(new object[] { "actionEntity", typeof(IBodyAnalysisType) })]
public static Obj CreateConnectedEntityRequest(this SubSystemDocument subSystemDocument, Obj actionEntity, string name)

```

#### Parameters

`subSystemDocument` SubSystemDocument

`actionEntity` [Obj](VM.API.Pre.Obj.md)

`name` [string](https://learn.microsoft.com/dotnet/api/system.string)

#### Returns

[Obj](VM.API.Pre.Obj.md)

### CreateEntitiesRequest(SubSystemDocument, Obj\[\], string)

```csharp
[NotNull(new string[] { "subSystemDocument" })]
public static void CreateEntitiesRequest(this SubSystemDocument subSystemDocument, Obj[] actionEntities, string name)

```

#### Parameters

`subSystemDocument` SubSystemDocument

`actionEntities` [Obj](VM.API.Pre.Obj.md)\[\]

`name` [string](https://learn.microsoft.com/dotnet/api/system.string)

### CreateEntityRequest(SubSystemDocument, Obj, string)

```csharp
[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "actionEntity" })]
[MatchTypeObj(new object[] { "actionEntity", typeof(IReportable) })]
public static Obj CreateEntityRequest(this SubSystemDocument subSystemDocument, Obj actionEntity, string name)

```

#### Parameters

`subSystemDocument` SubSystemDocument

`actionEntity` [Obj](VM.API.Pre.Obj.md)

`name` [string](https://learn.microsoft.com/dotnet/api/system.string)

#### Returns

[Obj](VM.API.Pre.Obj.md)

### CreateKinematicRequest(SubSystemDocument, Obj, string, Obj?, Obj?, OutputType?)

```csharp
[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "actionEntity" })]
public static Obj CreateKinematicRequest(this SubSystemDocument subSystemDocument, Obj actionEntity, string name, Obj? baseEntity = null, Obj? referenceMarker = null, RequestKinematic.OutputType? outputType = null)

```

#### Parameters

`subSystemDocument` SubSystemDocument

`actionEntity` [Obj](VM.API.Pre.Obj.md)

`name` [string](https://learn.microsoft.com/dotnet/api/system.string)

`baseEntity` [Obj](VM.API.Pre.Obj.md)?

`referenceMarker` [Obj](VM.API.Pre.Obj.md)?

`outputType` RequestKinematic.OutputType?

#### Returns

[Obj](VM.API.Pre.Obj.md)

### CreateStructuralRequest(SubSystemDocument, Obj, string, SideFilter, OutputType?)

```csharp
[NotNull(new string[] { "subSystemDocument" })]
[NotNullObj(new string[] { "actionEntity" })]
public static Obj CreateStructuralRequest(this SubSystemDocument subSystemDocument, Obj actionEntity, string name, RequestStructure.SideFilter sideFilter = SideFilter.Maximum, RequestStructure.OutputType? outputType = null)

```

#### Parameters

`subSystemDocument` SubSystemDocument

`actionEntity` [Obj](VM.API.Pre.Obj.md)

`name` [string](https://learn.microsoft.com/dotnet/api/system.string)

`sideFilter` RequestStructure.SideFilter

`outputType` RequestStructure.OutputType?

#### Returns

[Obj](VM.API.Pre.Obj.md)