### Create OQL Text Get Request from DataSet (No Parameters)

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/Core.html

Instantiates an IOQLTextGetRequest from a qualified DataSet name. This example shows how to retrieve the OQL query string and then use it to fetch data.

```Java
private String getOqlQueryFromDataSet(String dataSetName) {
    final IOQLTextGetRequest oqlTextGetRequest = Core.createOQLTextGetRequestFromDataSet(dataSetName);

    return oqlTextGetRequest.getQuery();
}

public Report generateReport() {
    String oqlQuery = getOqlQueryFromDataSet();
    final IDataTable dataTable = Core.retrieveOQLDataTable(context, oqlQuery);
    final List<? extends IDataRow> rows = dataTable.getRows();
    Report report = new Report();
    report.addRow(rows.get(0));

    return report;
}
```

--------------------------------

### Create OQL Text Get Request from DataSet (With Parameters)

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/Core.html

Instantiates an IOQLTextGetRequest from a qualified DataSet name and sets parameters for the OQL query. This example demonstrates how to define and apply query parameters.

```Java
public Report generateReport(String dataSetName) {
    final IOQLTextGetRequest oqlTextGetRequest = Core.createOQLTextGetRequestFromDataSet(dataSetName);
    final IParameterMap newParameterMap = oqlTextGetRequest.createParameterMap();
    newParameterMap.put("ParGroupNumber", 4); // Set value of ParGroupNumber parameter to 4
    oqlTextGetRequest.setParameters(newParameterMap);
    final IDataTable dataTable = Core.retrieveOQLDataTable(context, oqlTextGetRequest);
    final List<? extends IDataRow> rows = dataTable.getRows();
    Report report = new Report();
    report.addRow(rows.get(0));

    return report;
}
```

```OQL
FROM CRM.Customers As CustomerObj
INNER JOIN CustomerObj/CRM.Orders_Customer/CRM.Orders As OrderObj
WHERE CustomerObj/CRM.Customer_Group/CRM.Group/GroupNumber = $ParGroupNumber
GROUP BY CustomerObj/Name
SELECT CustomerObj/Name As Name, SUM(OrderObj/TotalAmount) As TotalAmount
```

--------------------------------

### start()

Source: https://apidocs.rnd.mendix.com/11/runtime/index-all.html

Starts a span and returns a Span object, which can be used to close the span.

```APIDOC
## start()

### Description
Starts the span and returns a [[com.mendix.tracing.Span]] object, which can be used to close the span.

### Method
N/A (Java Method Signature)

### Endpoint
N/A (Java Method Signature)

### Returns
* [[com.mendix.tracing.Span]] - The started span object.
```

--------------------------------

### startTransaction()

Source: https://apidocs.rnd.mendix.com/11/runtime/index-all.html

Starts a new transaction for the current context.

```APIDOC
## startTransaction()

### Description
Starts a new transaction for this context.

### Method
N/A (Java Method Signature)

### Endpoint
N/A (Java Method Signature)
```

--------------------------------

### Java User Action Example

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/systemwideinterfaces/core/package-summary.html

Example of extending the UserAction abstract class to define a custom user action. Implement executeAction() to define the action's logic.

```java
public class ExampleAction extends UserAction {
  private String param;
   
  public ExampleAction(String param) {
  super();
  this.param = param;
  }
   
  public String executeAction() throws Exception {
  return "Hello world! ("+this.param+")";
  }
   
  public String toString() {
  return "ExampleAction:: param="+this.param;
  }
  }
```

--------------------------------

### Get Jump-to Options and Prepare Jump

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/workflows/Workflow.html

Demonstrates how to retrieve jump-to options for a workflow, select source and target activities, and prepare a jump operation.

```java
Workflow workflow = Core.workflows().getWorkflow(context, workflowObject);
JumpToOptions jumpToOptions = workflow.getJumpToOptions();
JumpableWorkflowActivity sourceActivity = jumpToOptions.getCurrentActivities()
    .stream()
    .filter(a -> a.getDetails().getCaption().equals("MyUserTask1"))
    .findFirst()
    .get();
WorkflowActivityDetails targetActivity = sourceActivity.getApplicableTargets()
    .stream()
    .filter(a -> a.getCaption().equals("MyUserTask2"))
    .findFirst()
    .get();
Workflow updatedWorkflow = jumpToOptions.prepareJumpTo()
    .jumpActivityTo(sourceActivity, targetActivity)
    .applyJumpTo();

```

--------------------------------

### Start and Manage a Span

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/tracing/SpanBuilder.html

Starts a span and returns a Span object. The created span must have its status set and be closed. It is recommended to use a try-catch-finally block for proper management.

```java
Span start()
{
    var span = spanBuilder.start();
    try {
      ...
      span.setStatus(Span.Status.OK);
    } catch (Throwable exc) {
      span.setError(exc);
    } finally {
      span.close();
    }
  }
```

--------------------------------

### getHost

Source: https://apidocs.rnd.mendix.com/11/runtime/index-all.html

Gets the proxy host from an IProxyConfiguration.

```APIDOC
## getHost()

### Description
Gets the proxy host.

### Method
N/A (Method signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### Execute XPath Query with Variables and Limits

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/datastorage/XPathQuery.html

Example of creating and executing an XPath query using the fluent API. Demonstrates setting variables, amount, offset, and depth.

```Java
public List<IMendixObject> getObjectsWithValue(IContext context, ICore core, int value) {
    List<IMendixObject> results = core.createXPathQuery("//Entity[attribute=$value]")
        .setVariable("value", 1)
        .setAmount(500)
        .setOffset(50)
        .setDepth(1)
        .execute(context);
    return results;
}
```

--------------------------------

### Create OQL Text Get Request from DataSet (With Parameters)

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/internal/ICore.html

Instantiates an IOQLTextGetRequest from a qualified DataSet name and sets parameters for the OQL query. Use this when your OQL query requires parameters.

```java
public Report generateReport(String dataSetName) {
    final IOQLTextGetRequest oqlTextGetRequest = Core.createOQLTextGetRequestFromDataSet(dataSetName);
    final IParameterMap newParameterMap = oqlTextGetRequest.createParameterMap();
    newParameterMap.put("ParGroupNumber", 4); // Set value of ParGroupNumber parameter to 4
    oqlTextGetRequest.setParameters(newParameterMap);
    final IDataTable dataTable = Core.retrieveOQLDataTable(context, oqlTextGetRequest);
    final List<? extends IDataRow> rows = dataTable.getRows();
    Report report = new Report();
    report.addRow(rows.get(0));

    return report;
}
```

--------------------------------

### getStartTime (WorkflowRecord)

Source: https://apidocs.rnd.mendix.com/11/runtime/index-all.html

Fetches the start time of a workflow instance. This provides information about when a workflow execution began.

```APIDOC
## getStartTime (WorkflowRecord)

### Description
Returns the time at which the workflow instance started executing.

### Method
N/A (Method signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response
- **startTime** (DateTime) - The start time of the workflow instance.

### Response Example
N/A
```

--------------------------------

### Pagination Methods

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/systemwideinterfaces/connectionbus/requests/IRetrievalSchema.html

Methods for setting and getting the offset and amount for object retrieval.

```APIDOC
## getOffset

### Description
Returns the page size for object retrieval.

### Method
GET (conceptual)

### Endpoint
N/A (SDK method)

### Returns
- **long** - the row index of the first object to be retrieved

## setOffset

### Description
Sets the paging offset from where the result will be retrieved.

### Method
POST (conceptual)

### Endpoint
N/A (SDK method)

### Parameters
#### Path Parameters
None
#### Query Parameters
None
#### Request Body
- **offset** (long) - Required - the row index of the first object to be retrieved

## getAmount

### Description
Returns the page size for object retrieval.

### Method
GET (conceptual)

### Endpoint
N/A (SDK method)

### Returns
- **long** - the number of objects to retrieve

## setAmount

### Description
Sets the page size for object retrieval.

### Method
POST (conceptual)

### Endpoint
N/A (SDK method)

### Parameters
#### Path Parameters
None
#### Query Parameters
None
#### Request Body
- **amount** (long) - Required - the number of objects to retrieve
```

--------------------------------

### getStartTime (WorkflowActivityRecord)

Source: https://apidocs.rnd.mendix.com/11/runtime/index-all.html

Retrieves the start time of a workflow activity instance. This helps in tracking the execution timeline of workflow steps.

```APIDOC
## getStartTime (WorkflowActivityRecord)

### Description
Returns the start time of the workflow activity instance.

### Method
N/A (Method signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response
- **startTime** (DateTime) - The start time of the workflow activity.

### Response Example
N/A
```

--------------------------------

### prepareJumpTo

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/workflows/JumpToOptions.html

Initializes a builder to define and execute a jump-to configuration for the current workflow.

```APIDOC
## prepareJumpTo

### Description
Returns a builder to configure and apply a jump-to configuration for this workflow.

### Method
```java
JumpToBuilder prepareJumpTo()
```

### Returns
- `JumpToBuilder` - A builder to configure and apply a jump-to configuration for this workflow.
```

--------------------------------

### Create OQL Text Get Request

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/Core.html

Creates a new IOQLTextGetRequest for defining a textual OQL retrieval query.

```Java
public static IOQLTextGetRequest createOQLTextGetRequest()
```

--------------------------------

### Example of Extending UserAction

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/systemwideinterfaces/core/UserAction.html

This snippet demonstrates how to extend the UserAction class by defining a custom action with a parameter and implementing the executeAction method. It shows the basic structure for creating a user-defined action.

```java
public class ExampleAction extends UserAction {
  private String param;

  public ExampleAction(String param) {
  super();
  this.param = param;
  }

  public String executeAction() throws Exception {
  return "Hello world! ("+this.param+")";
  }

  public String toString() {
  return "ExampleAction:: param="+this.param;
  }
}
```

--------------------------------

### login (String userName, String password, IMxRuntimeRequest request)

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/internal/ICore.html

Logs in a user with the provided username, password, and HTTP request object. Returns the created session upon successful login.

```APIDOC
## login (String userName, String password, IMxRuntimeRequest request)

### Description
Login user with the given parameters.

### Method
ISession login(String userName, String password, IMxRuntimeRequest request) throws CoreException

### Parameters
#### Path Parameters
- **userName** (String) - Required - the username
- **password** (String) - Required - the password
- **request** (IMxRuntimeRequest) - Required - the HTTP request

### Returns
- **ISession** - the created session if login is successful

### Throws
- **CoreException** - when the login fails
```

--------------------------------

### getMetaObjects

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/internal/ICore.html

Gets all IMetaObjects.

```APIDOC
## getMetaObjects

### Description
Get all IMetaObjects.

### Method
N/A (Internal method signature)

### Returns
- **Iterable<IMetaObject>** - An iterable collection of all IMetaObjects.
```

--------------------------------

### Core.login(String, String, String)

Source: https://apidocs.rnd.mendix.com/11/runtime/index-all.html

Logs in a user with the provided username, password, and a string parameter.

```APIDOC
## login(String, String, String)

### Description
Logs in a user with the given parameters.

### Method
Static method in class com.mendix.core.Core

### Parameters
- **username** (String) - Description not provided
- **password** (String) - Description not provided
- **param3** (String) - Description not provided
```

--------------------------------

### getMetaAssociations

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/internal/ICore.html

Gets all IMetaAssociations.

```APIDOC
## getMetaAssociations

### Description
Get all IMetaAssociations.

### Method
N/A (Internal method signature)

### Returns
- **Iterable<IMetaAssociation>** - An iterable collection of all IMetaAssociations.
```

--------------------------------

### createSystemContext (Core)

Source: https://apidocs.rnd.mendix.com/11/runtime/index-all.html

Returns the context of the system session, which is always a sudo context.

```APIDOC
## createSystemContext()

### Description
Returns the context of the system session (this is always a sudo context).

### Method
Static method

### Class
com.mendix.core.Core
```

--------------------------------

### initialize

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/Core.html

Initializes this Core class, so that all methods can be invoked statically.

```APIDOC
## initialize

### Description
Initializes this Core class, so that all methods can be invoked statically.

### Method
N/A (Static method)

### Parameters
- **core** (ICore) - The core instance.
- **http** (Http) - The HTTP interface.
- **integration** (Integration) - The integration interface.
- **dataStorage** (DataStorage) - The data storage interface.
- **extensibility** (Extensibility) - The extensibility interface.
- **metrics** (Metrics) - The metrics interface.
- **tracing** (Tracing) - The tracing interface.
- **licenseInfo** (LicenseInfo) - The license information.
- **workflows** (Workflows) - The workflows interface.
- **web** (Web) - The web interface.
- **cspHelper** (CspHelper) - The CSP helper.

### Request Example
N/A

### Response
N/A (void method)
```

--------------------------------

### getDetail

Source: https://apidocs.rnd.mendix.com/11/runtime/index-all.html

Gets the detail from a WebserviceException.

```APIDOC
## getDetail()

### Description
Gets the detail from a WebserviceException.

### Method
N/A (Method Signature)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
- **detail** (string) - The detail of the exception.
```

--------------------------------

### getProxyConfiguration() - IHttpConfiguration

Source: https://apidocs.rnd.mendix.com/11/runtime/index-all.html

Gets the proxy configuration.

```APIDOC
## getProxyConfiguration()

### Description
Gets the proxy configuration.

### Method
N/A (Interface Method)

### Endpoint
N/A
```

--------------------------------

### login (String userName, String password)

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/internal/ICore.html

Logs in a user with the provided username and password. Returns the created session upon successful login.

```APIDOC
## login (String userName, String password)

### Description
Login user with the given username and password.

### Method
ISession login(String userName, String password) throws CoreException

### Parameters
#### Path Parameters
- **userName** (String) - Required - the username
- **password** (String) - Required - the password

### Returns
- **ISession** - the created session if login is successful

### Throws
- **CoreException** - when the login fails
```

--------------------------------

### getPort() - IProxyConfiguration

Source: https://apidocs.rnd.mendix.com/11/runtime/index-all.html

Gets the proxy port.

```APIDOC
## getPort()

### Description
Gets the proxy port.

### Method
N/A (Interface Method)

### Endpoint
N/A
```

--------------------------------

### getPassword() - IProxyConfiguration

Source: https://apidocs.rnd.mendix.com/11/runtime/index-all.html

Gets the proxy password.

```APIDOC
## getPassword()

### Description
Gets the proxy password.

### Method
N/A (Interface Method)

### Endpoint
N/A
```

--------------------------------

### instantiate

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/workflows/WorkflowDefinition.html

Instantiates a new workflow and returns the object representing it.

```APIDOC
## instantiate

### Description
Instantiates a new workflow and returns the object representing it.

### Method
Not applicable (Java method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
* `context` (IContext) - the context in which to create the workflow
* `workflowContext` (IMendixObject) - the context parameter object to associate with the workflow

### Returns
* `Workflow` - the instantiated workflow
```

--------------------------------

### getNonProxyHosts()

Source: https://apidocs.rnd.mendix.com/11/runtime/index-all.html

Gets the list of hosts that should not be proxied.

```APIDOC
## getNonProxyHosts()

### Description
Gets the non-proxy hosts.

### Method
Method in interface `com.mendix.http.IProxyConfiguration`

### Endpoint
N/A (Method Call)

### Parameters
None.

### Request Example
N/A

### Response
- **List<string>**: A list of non-proxy hostnames.
```

--------------------------------

### Create a Custom UserAction

Source: https://apidocs.rnd.mendix.com/11/runtime/allclasses-index.html

Extend the UserAction class to create custom user actions. Implement the executeAction method to define the action's logic. This example demonstrates a simple action that returns a greeting.

```Java
public class ExampleAction extends UserAction {
  private String param;

  public ExampleAction(String param) {
    super();
    this.param = param;
  }

  public String executeAction() throws Exception {
    return "Hello world! ("+this.param+")";
  }

  public String toString() {
    return "ExampleAction:: param="+this.param;
  }
}
```

--------------------------------

### initializeGuestSession

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/internal/ICore.html

Initialize a new session for a guest user.

```APIDOC
## initializeGuestSession

### Description
Initialize a new session for a guest user.

### Method
N/A (Method signature)

### Returns
- **ISession** - The newly created guest session.
```

--------------------------------

### getFaultString

Source: https://apidocs.rnd.mendix.com/11/runtime/index-all.html

Gets the fault string from a WebserviceException.

```APIDOC
## getFaultString()

### Description
Gets the fault string.

### Method
N/A (Method signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### initializeGuestSession

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/Core.html

Initialize a new session for a guest user.

```APIDOC
## initializeGuestSession

### Description
Initialize a new session for a guest user.

### Method
N/A (Static method)

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **session** (ISession) - The initialized guest session.
```

--------------------------------

### getFaultCode

Source: https://apidocs.rnd.mendix.com/11/runtime/index-all.html

Gets the fault code from a WebserviceException.

```APIDOC
## getFaultCode()

### Description
Gets the fault code.

### Method
N/A (Method signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### login (String, String)

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/Core.html

Logs in a user with the provided username and password. Throws a CoreException on failure.

```APIDOC
## login (String, String)

### Description
Login user with the given username and password.

### Method
public static ISession login(String userName, String password) throws CoreException

### Parameters
#### Path Parameters
- **userName** (String) - The username.
- **password** (String) - The password.

### Returns
- **ISession** - The created session if login is successful.

### Throws
- **CoreException** - When the login fails.

### See Also
- `LoginAction`
```

--------------------------------

### getFaultActor

Source: https://apidocs.rnd.mendix.com/11/runtime/index-all.html

Gets the fault actor from a WebserviceException.

```APIDOC
## getFaultActor()

### Description
Gets the fault actor.

### Method
N/A (Method signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### login (String, String, IMxRuntimeRequest)

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/Core.html

Logs in a user with the provided username, password, and an IMxRuntimeRequest object to determine the session ID. Throws a CoreException on failure.

```APIDOC
## login (String, String, IMxRuntimeRequest)

### Description
Login user with the given parameters.

### Method
public static ISession login(String userName, String password, IMxRuntimeRequest request) throws CoreException

### Parameters
#### Path Parameters
- **userName** (String) - The username.
- **password** (String) - The password.
- **request** (IMxRuntimeRequest) - The HTTP request that is used to determine the session ID.

### Returns
- **ISession** - The created session if login is successful.

### Throws
- **CoreException** - When the login fails.

### See Also
- `LoginAction`
```

--------------------------------

### getLanguage

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/internal/ICore.html

Gets the language for the current context.

```APIDOC
## getLanguage

### Description
Get the language for the current context.

### Method
N/A (Internal method signature)

### Parameters
- **context** (IContext) - Required - The context.
```

--------------------------------

### Get Model Version

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/Core.html

Retrieves the version of the Mendix model.

```java
public static String getModelVersion()
```

--------------------------------

### login (String, String, String)

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/Core.html

Logs in a user with the provided username, password, and current session ID. Throws a CoreException on failure.

```APIDOC
## login (String, String, String)

### Description
Login user with the given parameters.

### Method
public static ISession login(String userName, String password, String currentSessionId) throws CoreException

### Parameters
#### Path Parameters
- **userName** (String) - The username.
- **password** (String) - The password.
- **currentSessionId** (String) - Current session UUID.

### Returns
- **ISession** - The created session if login is successful.

### Throws
- **CoreException** - When the login fails.

### See Also
- `LoginAction`
```

--------------------------------

### createSystemContext

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/internal/ICore.html

Returns the system session context. This context is a sudo context and does not have an associated user or user roles, making it suitable for background or system-level operations.

```APIDOC
## createSystemContext

### Description
Returns the context of the system session. This is always a sudo context, meaning it has no associated user or user roles.

### Method
`IContext createSystemContext()`

### Returns
- returns the system session context.
```

--------------------------------

### getMetaPrimitive

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/internal/ICore.html

Gets the IMetaPrimitive based on a qualified attribute name.

```APIDOC
## getMetaPrimitive

### Description
Get the IMetaPrimitive based on a qualified attribute name (e.g. 'MyEntity.MyAttribute').

### Method
N/A (Internal method signature)

### Parameters
- **qualifiedAttributeName** (String) - Required - The qualified name of the attribute.
```

--------------------------------

### getMetaObject

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/internal/ICore.html

Gets the IMetaObject corresponding to the given metaobject name.

```APIDOC
## getMetaObject

### Description
Get the IMetaObject corresponding to the given metaobject name.

### Method
N/A (Internal method signature)

### Parameters
- **metaObjectName** (String) - Required - The name of the meta object.
```

--------------------------------

### login (String userName, String password, String currentSessionId)

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/internal/ICore.html

Logs in a user with the provided username, password, and current session ID. Returns the created session upon successful login.

```APIDOC
## login (String userName, String password, String currentSessionId)

### Description
Login user with the given parameters.

### Method
ISession login(String userName, String password, String currentSessionId) throws CoreException

### Parameters
#### Path Parameters
- **userName** (String) - Required - the username
- **password** (String) - Required - the password
- **currentSessionId** (String) - Required - current session UUID

### Returns
- **ISession** - the created session if login is successful

### Throws
- **CoreException** - when the login fails
```

--------------------------------

### getMetaAssociation

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/internal/ICore.html

Gets the IMetaAssociation corresponding to the given association name.

```APIDOC
## getMetaAssociation

### Description
Get the IMetaAssociation corresponding to the given association name.

### Method
N/A (Internal method signature)

### Parameters
- **association** (String) - Required - The name of the association.
```

--------------------------------

### LoginAction Constructor

Source: https://apidocs.rnd.mendix.com/11/runtime/index-all.html

Creates a login action with a context and parameters.

```APIDOC
## LoginAction(IContext, Map<String, ? extends Object>)

### Description
Creates a login action with a context and parameters.

### Method
Constructor for class com.mendix.core.action.user.LoginAction

### Parameters
- **context** (IContext) - Description not provided
- **parameters** (Map<String, ? extends Object>) - Description not provided
```

--------------------------------

### ICore.createMendixIdentifier(long)

Source: https://apidocs.rnd.mendix.com/11/runtime/index-all.html

Creates a new IMendixIdentifier for a given GUID.

```APIDOC
## ICore.createMendixIdentifier(long)

### Description
Creates a new IMendixIdentifier for the given guid.

### Method
Method

### Parameters
- guid (long) - The GUID for which to create the identifier.

### Response
- IMendixIdentifier: The created IMendixIdentifier.
```

--------------------------------

### initializeGuestSession

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/internal/ICore.html

Initializes a new session for a guest user.

```APIDOC
## initializeGuestSession

### Description
Initialize a new session for a guest user.

### Method
```
ISession initializeGuestSession() throws CoreException
```

### Returns
- **ISession** - the created session

### Throws
- **CoreException** - if something goes wrong during the initializing a guest session
```

--------------------------------

### Core.createMendixIdentifier(long)

Source: https://apidocs.rnd.mendix.com/11/runtime/index-all.html

Creates a new IMendixIdentifier for a given GUID.

```APIDOC
## Core.createMendixIdentifier(long)

### Description
Creates a new IMendixIdentifier for the given guid.

### Method
Static method

### Parameters
- guid (long) - The GUID for which to create the identifier.

### Response
- IMendixIdentifier: The created IMendixIdentifier.
```

--------------------------------

### initializeGuestSession

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/Core.html

Initializes a new session for a guest user.

```APIDOC
## initializeGuestSession

### Description
Initialize a new session for a guest user.

### Method
`public static ISession initializeGuestSession()`

### Returns
- **ISession** - Description: the created session

### Throws
- **CoreException**
```

--------------------------------

### Core.createOQLTextGetRequest

Source: https://apidocs.rnd.mendix.com/11/runtime/index-all.html

Creates a new IOQLTextGetRequest.

```APIDOC
## Core.createOQLTextGetRequest

### Description
Create a new IOQLTextGetRequest.

### Method
Static method

### Parameters
None

### Response
- IOQLTextGetRequest: A new IOQLTextGetRequest instance.
```

--------------------------------

### createMendixIdentifier (String)

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/internal/ICore.html

Creates an IMendixIdentifier for the given GUID string.

```APIDOC
## createMendixIdentifier (String)

### Description
Creates a IMendixIdentifier for the given guid.

### Method
createMendixIdentifier

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **guid** (String) - Required - the guid

### Response
#### Success Response (200)
- **IMendixIdentifier** - returns the created MendixIdentifier
```

--------------------------------

### createMendixIdentifier (long)

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/internal/ICore.html

Creates a new IMendixIdentifier for the given GUID.

```APIDOC
## createMendixIdentifier (long)

### Description
Creates a new IMendixIdentifier for the given guid.

### Method
createMendixIdentifier

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **guid** (long) - Required - the guid

### Response
#### Success Response (200)
- **IMendixIdentifier** - returns the created MendixIdentifier
```

--------------------------------

### createSystemContext (ICore)

Source: https://apidocs.rnd.mendix.com/11/runtime/index-all.html

Returns the context of the system session, which is always a sudo context.

```APIDOC
## createSystemContext()

### Description
Returns the context of the system session (this is always a sudo context).

### Method
Method

### Interface
com.mendix.core.internal.ICore
```

--------------------------------

### createSystemContext

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/Core.html

Creates and returns a system session context, which is a sudo context without an associated user or user roles.

```APIDOC
## createSystemContext

### Description
Returns the context of the system session (this is always a sudo context). The system session has no associated user or user roles.

### Method
public static IContext createSystemContext()

### Returns
- **IContext** - The system session context.
```

--------------------------------

### getPassword() - ICertificateInfo

Source: https://apidocs.rnd.mendix.com/11/runtime/index-all.html

Gets the password to the certificate file, or null when there is no certificate.

```APIDOC
## getPassword()

### Description
Gets the password to the certificate file, or null when there is no certificate.

### Method
N/A (Interface Method)

### Endpoint
N/A
```

--------------------------------

### getInstance

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/http/HttpConfiguration.html

Retrieves the current HTTP configuration instance.

```APIDOC
## getInstance

### Description
Returns the current `IHttpConfiguration`.

### Method
`static IHttpConfiguration`

### Endpoint
N/A (Static method)

### Parameters
None

### Response
#### Success Response
- **IHttpConfiguration** - The current HTTP configuration object.

### Response Example
```json
{
  "configuration": "[IHttpConfiguration object]"
}
```
```

--------------------------------

### Get Project ID

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/Core.html

Retrieves the unique identifier for the Mendix project.

```java
public static UUID getProjectId()
```

--------------------------------

### getConfiguration

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/internal/ICore.html

Returns the current configuration.

```APIDOC
## getConfiguration

### Description
Returns the current configuration.

### Method
N/A (Internal method signature)

### Returns
- **Configuration** - The current system configuration.
```

--------------------------------

### createMendixIdentifier (long)

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/Core.html

Creates a IMendixIdentifier object from a given long GUID.

```APIDOC
## createMendixIdentifier (long)

### Description
Creates a new IMendixIdentifier for the given guid.

### Method
public static IMendixIdentifier createMendixIdentifier(long guid)

### Parameters
#### Path Parameters
- **guid** (long) - The guid.

### Returns
- **IMendixIdentifier** - The created MendixIdentifier.
```

--------------------------------

### instantiate (WorkflowDefinition)

Source: https://apidocs.rnd.mendix.com/11/runtime/index-all.html

Instantiates a new workflow and returns the object representing it.

```APIDOC
## instantiate (WorkflowDefinition)

### Description
Instantiates a new workflow based on the workflow definition.

### Method
`instantiate(IContext, IMendixObject)`

### Parameters
* `IContext` (IContext) - Required - The context for the operation.
* `IMendixObject` (IMendixObject) - Required - An object to associate with the workflow instance.
```

--------------------------------

### createMendixIdentifier (String)

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/Core.html

Creates a IMendixIdentifier object from a given GUID string.

```APIDOC
## createMendixIdentifier (String)

### Description
Creates a IMendixIdentifier for the given guid.

### Method
public static IMendixIdentifier createMendixIdentifier(String guid)

### Parameters
#### Path Parameters
- **guid** (String) - The guid.

### Returns
- **IMendixIdentifier** - The created MendixIdentifier.
```

--------------------------------

### guid()

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/objectmanagement/DataValidationInfo.html

Retrieves the unique identifier of the object that contains the validated attributes.

```APIDOC
## Method guid

### Description
Gets the id of the object which contains the validated attributes.

### Signature
`public Long guid()`

### Returns
* **Long** - The id of the object which contain the validated attributes.
```

--------------------------------

### initializeSession

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/internal/ICore.html

Initialize a new session for the given user.

```APIDOC
## initializeSession

### Description
Initialize a new session for the given user.

### Method
N/A (Method signature)

### Parameters
#### Path Parameters
- **user** (IUser) - Required - The user for whom to initialize the session.
- **currentSessionId** (String) - Required - The ID of the current session.

### Returns
- **ISession** - The newly created session.
```

--------------------------------

### initializeSession

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/Core.html

Initialize a new session for the given user.

```APIDOC
## initializeSession

### Description
Initialize a new session for the given user.

### Method
N/A (Static method)

### Parameters
- **user** (IUser) - The user for whom to initialize the session.
- **currentSessionId** (String) - The ID of the current session.

### Request Example
N/A

### Response
#### Success Response (200)
- **session** (ISession) - The initialized session.
```

--------------------------------

### scheduleAtFixedRate (ICoreAction<?> action, Date firstRun, long period, TimeUnit timeUnit)

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/Core.html

Schedules a periodic action to run at a fixed rate, starting at a specific date and time. The action executes for the first time on the given date and subsequently with a fixed period between the start of each execution. This method does not return a result.

```APIDOC
## scheduleAtFixedRate (ICoreAction<?> action, Date firstRun, long period, TimeUnit timeUnit)

### Description
Schedules a periodic action that runs for the first time on the given date/time, and subsequently with the given period; that is executions will commence on firstRun then initialDelay+period, then initialDelay + 2 * period, and so on. No result will be returned.

### Parameters
#### Path Parameters
- **action** (ICoreAction<?>) - Required - the action to execute
- **firstRun** (Date) - Required - the Date/time on which the action will be executed the first time
- **period** (long) - Required - the period between each start of the execution of the action
- **timeUnit** (TimeUnit) - Required - the timeUnit in which the period is specified
```

--------------------------------

### getMaximumNumberConcurrentUsers

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/internal/ICore.html

Returns the maximum number of concurrent users since the server was started.

```APIDOC
## getMaximumNumberConcurrentUsers

### Description
Returns the maximum number of concurrent users since the server was started.

### Method
N/A (Internal method signature)

### Returns
- **int** - The maximum number of concurrent users.
```

--------------------------------

### Prepare and Execute User Action Call

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/internal/ICore.html

Use this snippet to prepare and execute a Java action call with parameters. Ensure the action name is correctly specified.

```java
Core.userActionCall("AModule.SomeJavaAction")
  .withParams("Value1", "Value2")
  .execute(context);
```

--------------------------------

### getStartupDateTime

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/internal/ICore.html

Returns the startup date and time of the Mendix runtime server.

```APIDOC
## getStartupDateTime

### Description
Returns the startup date time of the Mendix runtime server.

### Method
```
Date getStartupDateTime()
```

### Returns
- **Date** - the date time on which the Mendix runtime server was started
```

--------------------------------

### getIdentifier

Source: https://apidocs.rnd.mendix.com/11/runtime/index-all.html

Gets an identifier for certificate information or returns the identifier of an enumeration value.

```APIDOC
## getIdentifier()

### Description
Gets an identifier for this certificate information or returns the identifier of the enumeration value.

### Method
N/A (Method signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### getConfiguration

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/internal/ICore.html

Retrieves the current system configuration object.

```APIDOC
## getConfiguration Configuration getConfiguration()

### Description
Returns the current configuration.

### Returns
the configuration
```

--------------------------------

### getContext() (IMxRuntimeRequest)

Source: https://apidocs.rnd.mendix.com/11/runtime/index-all.html

Deprecated method to get the context from com.mendix.m2ee.api.IMxRuntimeRequest. No replacement available.

```APIDOC
## getContext() (IMxRuntimeRequest)

### Description
Deprecated. since 10.18. This method will be removed in Mendix 11. There is no replacement.
Returns the context.

### Method
N/A (Method Signature)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response
N/A

#### Response Example
N/A
```

--------------------------------

### ICore.createOQLTextGetRequest

Source: https://apidocs.rnd.mendix.com/11/runtime/index-all.html

Creates a new IOQLTextGetRequest.

```APIDOC
## ICore.createOQLTextGetRequest

### Description
Create a new IOQLTextGetRequest.

### Method
Method

### Parameters
None

### Response
- IOQLTextGetRequest: A new IOQLTextGetRequest instance.
```

--------------------------------

### getCaptionKey

Source: https://apidocs.rnd.mendix.com/11/runtime/index-all.html

Gets the caption of the enum constant. This method is available in the EnumConstant class.

```APIDOC
## getCaptionKey()

### Description
Returns the caption of the enum constant.

### Method
GET

### Endpoint
N/A (Java Method)

### Parameters
None

### Response
- **captionKey** (string) - The caption key of the enum constant.
```

--------------------------------

### getSubtypesOf

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/internal/ICore.html

Get all subtypes for an object type (including subtypes of subtypes, etc.).

```APIDOC
## getSubtypesOf

### Description
Get all subtypes for an object type (including subtypes of subtypes, etc.).

### Method
N/A (Method signature)

### Parameters
#### Path Parameters
- **objectType** (String) - Required - The name of the object type.

### Returns
- **List<String>** - A list of subtype names.
```

--------------------------------

### instantiate (Workflows)

Source: https://apidocs.rnd.mendix.com/11/runtime/index-all.html

Instantiates a new workflow and returns the object representing it.

```APIDOC
## instantiate (Workflows)

### Description
Instantiates a new workflow and returns the object representing it.

### Method
`instantiate(IContext, String, IMendixObject)`

### Parameters
* `IContext` (IContext) - Required - The context for the operation.
* `String` (String) - Required - The identifier for the workflow.
* `IMendixObject` (IMendixObject) - Required - An object to associate with the workflow instance.
```

--------------------------------

### getSubtypesOf

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/Core.html

Get all subtypes for an object type (including subtypes of subtypes, etc.).

```APIDOC
## getSubtypesOf

### Description
Get all subtypes for an object type (including subtypes of subtypes, etc.).

### Method
N/A (Static method)

### Parameters
- **objectType** (String) - The name of the object type to get subtypes for.

### Request Example
N/A

### Response
#### Success Response (200)
- **subtypes** (List<String>) - A list of subtype names.
```

--------------------------------

### getMetaObjects()

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/Core.html

Get all IMetaObject objects. Provides a way to iterate over all entities in the model.

```APIDOC
## getMetaObjects()

### Description
Get all IMetaObject objects. This method returns an iterable collection of all entities defined within the Mendix model.

### Method
`static Iterable<IMetaObject>`
```

--------------------------------

### login (Map)

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/Core.html

Performs a generic login using a map of parameters. This can be used as a replacement for LoginAction in modules. Throws a CoreException on failure.

```APIDOC
## login (Map)

### Description
Generic login method (can be used in modules in combination with LoginAction replacement).

### Method
public static ISession login(Map<String,? extends Object> params) throws CoreException

### Parameters
#### Path Parameters
- **params** (Map<String,? extends Object>) - The parameters for the login.

### Returns
- **ISession** - The created session if login was successful.

### Throws
- **CoreException** - When the login fails.

### See Also
- `LoginAction`
```

--------------------------------

### initializeSession

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/internal/ICore.html

Initializes a new session for a given user, optionally transferring data from a current session.

```APIDOC
## initializeSession

### Description
Initialize a new session for the given user.

### Method
```
ISession initializeSession(IUser user, String currentSessionId) throws CoreException
```

### Parameters
#### Path Parameters
- **user** (IUser) - Required - the user for which the session should be initialized
- **currentSessionId** (String) - Required - id of the current session, will be used to transfer data when current session is associated with a guest user

### Returns
- **ISession** - the created session

### Throws
- **CoreException**
```

--------------------------------

### getMetaAssociations()

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/Core.html

Get all IMetaAssociation objects. Provides a way to iterate over all associations in the model.

```APIDOC
## getMetaAssociations()

### Description
Get all IMetaAssociation objects. This method returns an iterable collection of all associations defined within the Mendix model.

### Method
`static Iterable<IMetaAssociation>`
```

--------------------------------

### initializeSession

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/Core.html

Initializes a new session for a given user, optionally transferring data from a current session if it's associated with a guest user.

```APIDOC
## initializeSession

### Description
Initialize a new session for the given user.

### Method
`public static ISession initializeSession(IUser user, String currentSessionId)`

### Parameters
#### Path Parameters
- **user** (IUser) - Description: the user for which the session should be initialized
- **currentSessionId** (String) - Description: id of the current session, will be used to transfer data when current session is associated with a guest user

### Returns
- **ISession** - Description: the created session

### Throws
- **CoreException**
```

--------------------------------

### LoginAction Constructor

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/action/user/LoginAction.html

Creates a login action with a context and parameters. The parameters can contain the following values (the userName and password are mandatory; the others are optional): userName - the name of the user (mandatory), password - the password of the user (mandatory), currentSessionId - the ID of the session to reuse for this login instead of creating a new one, request - the current runtime request (of type IMxRuntimeRequest), which is used for logging the origin of the login.

```APIDOC
## LoginAction Constructor

### Description
Creates a login action with a context and parameters. The parameters can contain the following values (the userName and password are mandatory; the others are optional):
- userName - the name of the user (mandatory)
- password - the password of the user (mandatory)
- currentSessionId - the ID of the session to reuse for this login instead of creating a new one
- request - the current runtime request (of type IMxRuntimeRequest), which is used for logging the origin of the login.

### Parameters
- **context** (IContext) - Required - The context for executing the action and checking access.
- **params** (Map<String,? extends Object>) - Required - The parameters for the login action, which must include userName and password.
  - **userName** (String) - Mandatory - The name of the user.
  - **password** (String) - Mandatory - The password of the user.
  - **currentSessionId** (String) - Optional - The ID of the session to reuse.
  - **request** (IMxRuntimeRequest) - Optional - The current runtime request.
```

--------------------------------

### getMaximumNumberConcurrentUsers

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/internal/ICore.html

Returns the maximum number of concurrent users that have been active since the server was started.

```APIDOC
## getMaximumNumberConcurrentUsers

### Description
Returns the maximum number of concurrent users since the server was started.

### Method
(Implicitly Java method call)

### Parameters
(None)

### Throws
- **CoreException** - If an error occurs while retrieving the information.

### Returns
- **int** - The maximum number of concurrent users.
```

--------------------------------

### login (userName, password)

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/internal/ICore.html

Login user with the given username and password.

```APIDOC
## login

### Description
Login user with the given username and password.

### Method
N/A (Method signature)

### Parameters
#### Path Parameters
- **userName** (String) - Required - The username.
- **password** (String) - Required - The password.

### Returns
- **ISession** - The user's session.
```

--------------------------------

### getColumn

Source: https://apidocs.rnd.mendix.com/11/runtime/index-all.html

Gets the column at the specified column index. This method is available in the IExcelGrid interface.

```APIDOC
## getColumn(int)

### Description
Returns the column at the specified column index.

### Method
GET

### Endpoint
N/A (Java Method)

### Parameters
- **columnIndex** (int) - Required - The index of the column.

### Response
- **column** (object) - The Excel column at the specified index.
```

--------------------------------

### login(String, String)

Source: https://apidocs.rnd.mendix.com/11/runtime/index-all.html

Logs in a user with the given username and password. This method is available statically via Core and on the ICore interface.

```APIDOC
## login(String, String)

### Description
Logs in a user with the provided username and password.

### Method
Static method (com.mendix.core.Core) or Method within an interface (com.mendix.core.internal.ICore)

### Endpoint
N/A

### Parameters
- **username** (String) - Required - The username for login.
- **password** (String) - Required - The password for login.

### Request Example
N/A

### Response
N/A
```

--------------------------------

### getCertificateFile

Source: https://apidocs.rnd.mendix.com/11/runtime/index-all.html

Gets the certificate file, or null if there is no certificate. This method is part of the ICertificateInfo interface.

```APIDOC
## getCertificateFile()

### Description
Gets the certificate file, or null when there is no certificate.

### Method
GET

### Endpoint
N/A (Java Method)

### Parameters
None

### Response
- **certificateFile** (string or null) - The certificate file path or null.
```

--------------------------------

### login (userName, password, request)

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/internal/ICore.html

Login user with the given parameters.

```APIDOC
## login

### Description
Login user with the given parameters.

### Method
N/A (Method signature)

### Parameters
#### Path Parameters
- **userName** (String) - Required - The username.
- **password** (String) - Required - The password.
- **request** (IMxRuntimeRequest) - Required - The runtime request object.

### Returns
- **ISession** - The user's session.
```

--------------------------------

### ScheduledEventExecution Enum Constants

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/conf/Configuration.ScheduledEventExecution.html

Defines the options to control which scheduled events get executed.

```APIDOC
## Enum Constant Summary 

Enum Constants

Enum Constant
Description

`ALL`
Execute all scheduled events.

`NONE`
Execute no scheduled events.

`SPECIFIED`
Executed only the events specified in `Configuration.getMyScheduledEvents()`.
```

--------------------------------

### run

Source: https://apidocs.rnd.mendix.com/11/runtime/index-all.html

Starts the span, runs an action, and then closes the span. This method is part of the SpanBuilder interface.

```APIDOC
## run(Function<Span, R>)

### Description
Start the span, run an action and then close the span.

### Method
N/A (Interface method)

### Endpoint
N/A

### Parameters
- **action** (Function<Span, R>) - Required - The action to run within the span.

### Request Example
N/A

### Response
- **R** - The result of the action.

### Response Example
N/A
```

--------------------------------

### login (username, password, request)

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/core/Core.html

Login user with the given parameters.

```APIDOC
## login (username, password, request)

### Description
Login user with the given parameters.

### Method
N/A (Static method)

### Parameters
- **userName** (String) - The username.
- **password** (String) - The password.
- **request** (IMxRuntimeRequest) - The runtime request object.

### Request Example
N/A

### Response
#### Success Response (200)
- **session** (ISession) - The logged-in session.
```

--------------------------------

### getRequestStartTime() - IContext

Source: https://apidocs.rnd.mendix.com/11/runtime/index-all.html

Returns the timestamp (in milliseconds since the Unix epoch) of the request that started this context.

```APIDOC
## getRequestStartTime()

### Description
Returns the timestamp (in milliseconds since the Unix epoch) of the request that started this context.

### Method
N/A (Interface Method)

### Endpoint
N/A
```

--------------------------------

### getJumpToOptions

Source: https://apidocs.rnd.mendix.com/11/runtime/com/mendix/workflows/Workflow.html

Retrieves the available jump-to options for the workflow. This includes details on activities the workflow can jump to.

```APIDOC
## getJumpToOptions

### Description
Returns the list of possible workflow activities the workflow can jump to.

### Method
N/A (Method signature provided)

### Endpoint
N/A

### Parameters
None

### Response
#### Success Response
- **JumpToOptions**: An interface for jump-to operations.
```