Mendix Documentation

https://docs.mendix.com/
Admin
Mendix Documentation provides comprehensive guides and references for Mendix products, including...
Tokens:4,354,506
Snippets:69,299
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Prepare Command Example

Source: https://docs.mendix.com/_print/refguide8/native-builder

Use the 'prepare' command to create app assets on GitHub and App Center, set up icons and splash screens, and verify project paths. This command generates a configuration file for future use and can update existing configurations.

```bash
native-builder.exe prepare --github-access-token <token> --appcenter-api-token <token> --java-home <absolute-path> --mxbuild-path <absolute-path> --project-path <absolute-path-to-mpr-file> --projectName CoolApp --app-identifier "com.company.myapp" --app-name "My Cool App" --mendix-version 8.5.0
```

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

### Tekton Pipeline Runs List Example

Source: https://docs.mendix.com/_print/developerportal/deploy/private-cloud-tekton

Example output for the 'kubectl get pipelineruns' command, showing the status, reason, start time, and completion time for each pipeline run.

```text
NAME                                       SUCCEEDED   REASON      STARTTIME   COMPLETIONTIME
mx-pipeline-app-create-run-generic-zzt8h   False       Failed      8d          8d
mx-pipeline-build-run-gitlab-2bjc7         True        Succeeded   22d         22d
```

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

### Guid Data Type Write Example

Source: https://docs.mendix.com/appstore/modules/opc-ua-connector

Example of a Guid data type write request to an OPC UA server.

```String
"cd1fdbc3-1f45-4fe8-9bff-b4927d5401c4"
```

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

### Example Output for Setting Environment Settings

Source: https://docs.mendix.com/apidocs-mxsdk/apidocs/deploy-api

Illustrates the JSON response after successfully setting environment settings, reflecting the updated values.

```JSON
{
     "Constants" : [{
         "Name" :  "MyFirstModule.BooleanConstant" ,
         "DataType" :  "_Boolean" ,
         "Value" :  "true" ,
         "DeployedValue" :  "false"
     },{
         "Name" :  "MyFirstModule.DateTime" ,
         "DataType" :  "DateTime" ,
         "Value" :  "2013-12-12T16:02:32" ,
         "DeployedValue" :  "2013-12-12T16:02:32"
     }],
     "CustomSettings" : [],
     "ScheduledEvents" : [{
         "Name" :  "MyFirstModule.Monitor_Scheduled_event" ,
         "DeployedValue" :  "Disabled" ,
         "Value" :  "Enabled"
     }]
}
```

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

### Example: Creating a PostgreSQL Service Instance

Source: https://docs.mendix.com/_print/developerportal/deploy/deploying-to-mindsphere

An example of creating a PostgreSQL service instance named 'myapp-db' with the 'postgresql-xs' plan.

```bash
cf create-service postgresql10 postgresql-xs myapp-db
```

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

### Guid Data Type Read Example

Source: https://docs.mendix.com/appstore/modules/opc-ua-connector

Example of a Guid data type read response from an OPC UA server.

```JSON
{"value": "cd1fdbc3-1f45-4fe8-9bff-b4927d5401c4"}
```

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

### Example GET Request with Authentication

Source: https://docs.mendix.com/_print/apidocs-mxsdk/apidocs/feedback-api-v2

This example shows how to make a GET request to the Feedback API, including the required Authorization header with a Personal Access Token (PAT).

```http
GET /feedback-api.mendix.com/v2/feedback-items HTTP/1.1
Authorization: MxToken 7LJE…vk
```

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

### Start Application

Source: https://docs.mendix.com/_print/developerportal/deploy/linux-pad

Navigates into the extracted application directory and executes the start script.

```bash
cd your-desired-directory
sh bin/start
```

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

### Example Output for Create Free App Environment

Source: https://docs.mendix.com/apidocs-mxsdk/apidocs/deploy-api

Example JSON response after successfully creating a Free App environment. It returns the details of the newly created app.

```JSON
{
    "Name": "Calculation App",
    "Url": "https://calc.mendixcloud.com",
    "ProjectId": "fae5de74-69c2-4488-a4de-abf89daac63e",
    "AppId": "calc"
}
```

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

### Example GET Request for Epics

Source: https://docs.mendix.com/_print/apidocs-mxsdk/apidocs/epics-api

This example demonstrates how to make a GET request to retrieve epics for a specific app ID. Ensure you include the Authorization header with your personal access token.

```http
GET /projects/d92064a5-b1fd-4be4-97db-53fc90201d1c/epics HTTP/1.1
Authorization: MxToken 7LJE…vk
```

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

### PostgreSQL Database Configuration Example

Source: https://docs.mendix.com/_print/developerportal/deploy/portable-apps-distribution/reference

Example configuration for connecting to a PostgreSQL database.

```properties
# Database configuration
runtime.params {
  DatabaseType = POSTGRESQL
  DatabaseHost = "localhost:5432"
  DatabaseName = MyMendixDB
  DatabaseUserName = mymendixusername
  DatabasePassword=mymendixusernamepassword
}
```

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

### Get Security Group by Name Example

Source: https://docs.mendix.com/_print/apidocs-mxsdk/apidocs/user-management-api

Example HTTP request to retrieve a security group named 'RnD'.

```http
GET /legacy-api/1/groups/RnD HTTP/1.1
Host: usermanagement.mendix.com
Content-Type: application/json
Mendix-Username:janedoe@example.com
Mendix-ApiKey:87a8a34d-5ee7-43ba-81f0-7b1b17d5ecd7
```

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

### Get Start Environment Status

Source: https://docs.mendix.com/apidocs-mxsdk/apidocs/deploy-api

Retrieves the status of a previously initiated environment start action using the JobId.

```APIDOC
## Get Start Environment Status

### Description
Retrieve the status of the start environment action.

### Method
GET

### Endpoint
https://deploy.mendix.com/api/1/apps/<AppId>/environments/<Mode>/start/<JobId>

### Request Example
```
GET /api/1/apps/calc/environments/Acceptance/start/02df2e50-0e79-11e4-9191-0800200c9a66
Host: deploy.mendix.com

Content-Type: application/json
Mendix-Username: richard.ford51@example.com
Mendix-ApiKey:  26587896-1cef-4483-accf-ad304e2673d6
```

### Response
#### Success Response (200)
- **Status** (String): Possible values are Starting and Started

#### Response Example
```json
{
     "Status" :  "Starting"
}
```

### Error Codes
HTTP Status | Error code | Description  
---|---|---
400 | INVALID_PARAMETERS | Not enough parameters given. Please set AppId and Mode parameters.  
400 | INVALID_ENVIRONMENT | Could not parse environment mode 'mode'. Valid options are Test, Acceptance, Production or the name of a flexible environment.  
404 | ENVIRONMENT_NOT_FOUND | Environment not found  
404 | NO_SUCH_STARTJOB | Job not found.  
500 | NO_PACKAGE | Cannot start app. There should be a package configured for this environment.  
500 | ALREADY_LOCKED | Cannot start app. There is already a lock on this environment.  
500 | ALREADY_STARTED | Cannot start app. App is already running.  
500 | DB_SYNC_FAILED | Cannot start app. Synchronization of database failed.  
500 | INVALID_DB_STRUCTURE | Cannot start app. The database is out-of-sync with the model. Please set AutoSyncDb parameter to true to synchronize the database automatically on startup.  
500 | MISSING_CONSTANT | Cannot start app. Missing one or more constant values.  
500 | INSECURE_ADMIN_PASSWORD | Cannot start app. There is a user with administrator role with password '1'. This is not allowed.  
500 | STARTUP_ACTION_FAILED | Cannot start app. Startup action failed.  
500 | START_FAILED | Cannot start app: result (detail status)
```

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

### Example iOS Icons Configuration (Version 1)

Source: https://docs.mendix.com/_print/refguide/mobile/distributing-mobile-apps/building-native-apps/native-template

Provides a complete JSON example of the `ios.json` configuration file for version 1. This demonstrates all required keys for setting up app icons across different devices and scales.

```json
{
    "images": [
        {
            "size": "20x20",
            "idiom": "ipad",
            "scale": "1x",
            "type": "icon",
            "filename": "notification@1x.png"
        },
        {
            "size": "20x20",
            "idiom": "ipad",
            "scale": "2x",
            "type": "icon",
            "filename": "notification@2x.png"
        },
        {
            "size": "20x20",
            "idiom": "iphone",
            "scale": "2x",
            "type": "icon",
            "filename": "notification@2x.png"
        },
        {
            "size": "20x20",
            "idiom": "iphone",
            "scale": "3x",
            "type": "icon",
            "filename": "notification@3x.png"
        },
        {
            "size": "29x29",
            "idiom": "ipad",
            "scale": "1x",
            "type": "icon",
            "filename": "settings@1x.png"
        },
        {
            "size": "29x29",
            "idiom": "ipad",
            "scale": "2x",
            "type": "icon",
            "filename": "settings@2x.png"
        },
        {
            "size": "29x29",
            "idiom": "iphone",
            "scale": "2x",
            "type": "icon",
            "filename": "settings@2x.png"
        },
        {
            "size": "29x29",
            "idiom": "iphone",
            "scale": "3x",
            "type": "icon",
            "filename": "settings@3x.png"
        },
        {
            "size": "40x40",
            "idiom": "ipad",
            "scale": "1x",
            "type": "icon",
            "filename": "spotlight@1x.png"
        },
        {
            "size": "40x40",
            "idiom": "ipad",
            "scale": "2x",
            "type": "icon",
            "filename": "spotlight@2x.png"
        },
        {
            "size": "40x40",
            "idiom": "iphone",
            "scale": "2x",
            "type": "icon",
            "filename": "spotlight@2x.png"
        },
        {
            "size": "40x40",
            "idiom": "iphone",
            "scale": "3x",
            "type": "icon",
            "filename": "spotlight@3x.png"
        },
        {
            "size": "60x60",
            "idiom": "iphone",
            "scale": "2x",
            "type": "icon",
            "filename": "app@2x.png"
        },
        {
            "size": "60x60",
            "idiom": "iphone",
            "scale": "3x",
            "type": "icon",
            "filename": "app@3x.png"
        },
        {
            "size": "76x76",
            "idiom": "ipad",
            "scale": "1x",
            "type": "icon",
            "filename": "ipadapp@1x.png"
        },
        {
            "size": "76x76",
            "idiom": "ipad",
            "scale": "2x",
            "type": "icon",
            "filename": "ipadapp@2x.png"
        },
        {
            "size": "83.5x83.5",
            "idiom": "ipad",
            "scale": "2x",
            "type": "icon",
            "filename": "ipadproapp@2x.png"
        },
        {
            "size": "1024x1024",
            "idiom": "ios-marketing",
            "scale": "1x",
            "type": "icon",
            "filename": "appstore@1x.png"
        }
    ],
    "version": 1
}
```

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

### Initialize and Migrate Installer

Source: https://docs.mendix.com/_print/private-mendix-platform/quickstart

Uploads the document generation service directory to your private registry using the installer init migrate command.

```bash
installer init migrate
```

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

### Get GUID JavaScript Action

Source: https://docs.mendix.com/_print/refguide10/mobile/using-mobile-capabilities/local-notifications/local-notif-data

Calls the 'GetGuid' JavaScript action from NanoflowCommons to obtain the GUID of the 'TestEntity' object.

```Nanoflow
Call JavaScript Action 'GetGuid'
Entity Object: $FirstTestEntityObject
Variable name: GUIDForFirstObject
```

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

### Example Job Status Request

Source: https://docs.mendix.com/_print/apidocs-mxsdk/apidocs/deploy-api-2

An example GET request to check the status of a specific job, including authentication headers.

```HTTP
GET /api/v2/apps/calc/jobs/66046953-ecf7-4550-a889-4b7e9f1e1705
Host: deploy.mendix.com

Mendix-Username: richard.ford51@example.com
Mendix-ApiKey:  26587896-1cef-4483-accf-ad304e2673d6
```

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

### Build and Install Extension

Source: https://docs.mendix.com/_print/apidocs-mxsdk/apidocs/web-extensibility-api-11/getting-started

Execute this command to build your extension. If the .mpr file path is configured, this installs the extension into the app directory.

```bash
npm run build
```

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

### Start Tailscale Agent with Authentication Key

Source: https://docs.mendix.com/_print/control-center/configure-private-connectivity

Run this command on the machine where the agent is installed to start the agent and connect it to your network. Replace `<AUTH_KEY>` with your agent's actual authentication key.

```bash
tailscale up --auth-key=<AUTH_KEY>
```

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

### Get Environment Permissions

Source: https://docs.mendix.com/_print/apidocs-mxsdk/apidocs/deploy-api-4

Retrieves the permissions for a specific application environment. This is an example of a GET operation that requires read scope.

```APIDOC
## GET /apps/{appId}/environments/{environmentId}/permissions

### Description
Retrieves the permissions for a specific application environment.

### Method
GET

### Endpoint
/apps/{appId}/environments/{environmentId}/permissions

### Parameters
#### Path Parameters
- **appId** (string) - Required - The ID of the application.
- **environmentId** (string) - Required - The ID of the environment.

### Response
#### Success Response (200)
- **permissions** (object) - An object containing the permissions for the environment.

### Response Example
{
  "example": "{\"permissions\": {\"anonymous\": {\"canLogin\": true, \"canUseDatabase\": true}}}"
}
```
Tokens:
Raw