Cloud API - Platform Settings and Utilities

Updated

Cloud API - Platform Settings and Utilities

Base URL: https://public-api.loadgen.cloud

This article documents platform settings and utility endpoints (host/tenant settings, localization, lookups, and other supporting services).

GetAuditLogs

Method: GET

Path: /api/services/app/AuditLog/GetAuditLogs

Operation ID: ApiServicesAppAuditlogGetauditlogsGet

Tag: AuditLog

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| StartDate | query | string (date-time) | No | | format: date-time |

| EndDate | query | string (date-time) | No | | format: date-time |

| UserName | query | string | No | | |

| ServiceName | query | string | No | | |

| MethodName | query | string | No | | |

| BrowserInfo | query | string | No | | |

| HasException | query | boolean | No | | |

| MinExecutionDuration | query | integer (int32) | No | | format: int32 |

| MaxExecutionDuration | query | integer (int32) | No | | format: int32 |

| Sorting | query | string | No | | |

| MaxResultCount | query | integer (int32) | No | | format: int32

min: 1

max: 1000 |

| SkipCount | query | integer (int32) | No | | format: int32

min: 0

max: 2147483647 |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: AuditLogListDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| items | array | No | | |

| totalCount | integer (int32) | No | | format: int32 |

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"userId": 0,

"userName": "string",

"impersonatorTenantId": 0

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/AuditLog/GetAuditLogs?StartDate=2025-01-01T00%3A00%3A00Z&EndDate=2025-01-01T00%3A00%3A00Z&UserName=string" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/AuditLog/GetAuditLogs?StartDate=2025-01-01T00%3A00%3A00Z&EndDate=2025-01-01T00%3A00%3A00Z&UserName=string"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetAuditLogsToExcel

Method: GET

Path: /api/services/app/AuditLog/GetAuditLogsToExcel

Operation ID: ApiServicesAppAuditlogGetauditlogstoexcelGet

Tag: AuditLog

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| StartDate | query | string (date-time) | No | | format: date-time |

| EndDate | query | string (date-time) | No | | format: date-time |

| UserName | query | string | No | | |

| ServiceName | query | string | No | | |

| MethodName | query | string | No | | |

| BrowserInfo | query | string | No | | |

| HasException | query | boolean | No | | |

| MinExecutionDuration | query | integer (int32) | No | | format: int32 |

| MaxExecutionDuration | query | integer (int32) | No | | format: int32 |

| Sorting | query | string | No | | |

| MaxResultCount | query | integer (int32) | No | | format: int32

min: 1

max: 1000 |

| SkipCount | query | integer (int32) | No | | format: int32

min: 0

max: 2147483647 |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: FileDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| fileName | string | Yes | | minLength: 1 |

| fileToken | string | Yes | | minLength: 1 |

| fileType | string | No | | |

Example response

`json

{

"result": {

"fileName": "string",

"fileToken": "string",

"fileType": "string"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/AuditLog/GetAuditLogsToExcel?StartDate=2025-01-01T00%3A00%3A00Z&EndDate=2025-01-01T00%3A00%3A00Z&UserName=string" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/AuditLog/GetAuditLogsToExcel?StartDate=2025-01-01T00%3A00%3A00Z&EndDate=2025-01-01T00%3A00%3A00Z&UserName=string"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetEntityChanges

Method: GET

Path: /api/services/app/AuditLog/GetEntityChanges

Operation ID: ApiServicesAppAuditlogGetentitychangesGet

Tag: AuditLog

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| StartDate | query | string (date-time) | No | | format: date-time |

| EndDate | query | string (date-time) | No | | format: date-time |

| UserName | query | string | No | | |

| EntityTypeFullName | query | string | No | | |

| Sorting | query | string | No | | |

| MaxResultCount | query | integer (int32) | No | | format: int32

min: 1

max: 1000 |

| SkipCount | query | integer (int32) | No | | format: int32

min: 0

max: 2147483647 |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: EntityChangeListDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| items | array | No | | |

| totalCount | integer (int32) | No | | format: int32 |

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"userId": 0,

"userName": "string",

"changeTime": "2025-01-01T00:00:00Z"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/AuditLog/GetEntityChanges?StartDate=2025-01-01T00%3A00%3A00Z&EndDate=2025-01-01T00%3A00%3A00Z&UserName=string" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/AuditLog/GetEntityChanges?StartDate=2025-01-01T00%3A00%3A00Z&EndDate=2025-01-01T00%3A00%3A00Z&UserName=string"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetEntityChangesToExcel

Method: GET

Path: /api/services/app/AuditLog/GetEntityChangesToExcel

Operation ID: ApiServicesAppAuditlogGetentitychangestoexcelGet

Tag: AuditLog

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| StartDate | query | string (date-time) | No | | format: date-time |

| EndDate | query | string (date-time) | No | | format: date-time |

| UserName | query | string | No | | |

| EntityTypeFullName | query | string | No | | |

| Sorting | query | string | No | | |

| MaxResultCount | query | integer (int32) | No | | format: int32

min: 1

max: 1000 |

| SkipCount | query | integer (int32) | No | | format: int32

min: 0

max: 2147483647 |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: FileDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| fileName | string | Yes | | minLength: 1 |

| fileToken | string | Yes | | minLength: 1 |

| fileType | string | No | | |

Example response

`json

{

"result": {

"fileName": "string",

"fileToken": "string",

"fileType": "string"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/AuditLog/GetEntityChangesToExcel?StartDate=2025-01-01T00%3A00%3A00Z&EndDate=2025-01-01T00%3A00%3A00Z&UserName=string" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/AuditLog/GetEntityChangesToExcel?StartDate=2025-01-01T00%3A00%3A00Z&EndDate=2025-01-01T00%3A00%3A00Z&UserName=string"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetEntityHistoryObjectTypes

Method: GET

Path: /api/services/app/AuditLog/GetEntityHistoryObjectTypes

Operation ID: ApiServicesAppAuditlogGetentityhistoryobjecttypesGet

Tag: AuditLog

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: array

Response fields

None

Example response

`json

{

"result": [

{

"name": "string",

"value": "string"

}

],

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/AuditLog/GetEntityHistoryObjectTypes" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/AuditLog/GetEntityHistoryObjectTypes"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetEntityPropertyChanges

Method: GET

Path: /api/services/app/AuditLog/GetEntityPropertyChanges

Operation ID: ApiServicesAppAuditlogGetentitypropertychangesGet

Tag: AuditLog

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| entityChangeId | query | integer (int64) | No | | format: int64 |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: array

Response fields

None

Example response

`json

{

"result": [

{

"entityChangeId": 0,

"newValue": "string",

"originalValue": "string"

}

],

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/AuditLog/GetEntityPropertyChanges?entityChangeId=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/AuditLog/GetEntityPropertyChanges?entityChangeId=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetEntityTypeChanges

Method: GET

Path: /api/services/app/AuditLog/GetEntityTypeChanges

Operation ID: ApiServicesAppAuditlogGetentitytypechangesGet

Tag: AuditLog

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| EntityTypeFullName | query | string | No | | |

| EntityId | query | string | No | | |

| Sorting | query | string | No | | |

| MaxResultCount | query | integer (int32) | No | | format: int32

min: 1

max: 1000 |

| SkipCount | query | integer (int32) | No | | format: int32

min: 0

max: 2147483647 |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: EntityChangeListDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| items | array | No | | |

| totalCount | integer (int32) | No | | format: int32 |

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"userId": 0,

"userName": "string",

"changeTime": "2025-01-01T00:00:00Z"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/AuditLog/GetEntityTypeChanges?EntityTypeFullName=string&EntityId=string&Sorting=string" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/AuditLog/GetEntityTypeChanges?EntityTypeFullName=string&EntityId=string&Sorting=string"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

FindUsers

Method: POST

Path: /api/services/app/CommonLookup/FindUsers

Operation ID: ApiServicesAppCommonlookupFindusersPost

Tag: CommonLookup

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: FindUsersInput

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| excludeCurrentUser | boolean | No | | |

| filter | string | No | | |

| maxResultCount | integer (int32) | No | | format: int32

min: 1

max: 1000 |

| skipCount | integer (int32) | No | | format: int32

min: 0

max: 2147483647 |

| tenantId | integer (int32) | No | | format: int32 |

Example request body

`json

{

"tenantId": 0,

"excludeCurrentUser": false,

"maxResultCount": 1

}

`

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: NameValueDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| items | array | No | | |

| totalCount | integer (int32) | No | | format: int32 |

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"name": "string",

"value": "string"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/CommonLookup/FindUsers" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"tenantId":0,"excludeCurrentUser":false,"maxResultCount":1}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/CommonLookup/FindUsers"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"tenantId": 0,

"excludeCurrentUser": false,

"maxResultCount": 1

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

GetDefaultEditionName

Method: GET

Path: /api/services/app/CommonLookup/GetDefaultEditionName

Operation ID: ApiServicesAppCommonlookupGetdefaulteditionnameGet

Tag: CommonLookup

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetDefaultEditionNameOutput

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| name | string | No | | |

Example response

`json

{

"result": {

"name": "string"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/CommonLookup/GetDefaultEditionName" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/CommonLookup/GetDefaultEditionName"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetEditionsForCombobox

Method: GET

Path: /api/services/app/CommonLookup/GetEditionsForCombobox

Operation ID: ApiServicesAppCommonlookupGeteditionsforcomboboxGet

Tag: CommonLookup

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| onlyFreeItems | query | boolean | No | false | |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: SubscribableEditionComboboxItemDtoListResultDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| items | array | No | | |

Example response

`json

{

"result": {

"items": [

{

"isFree": false,

"value": "string",

"displayText": "string"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/CommonLookup/GetEditionsForCombobox?onlyFreeItems=false" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/CommonLookup/GetEditionsForCombobox?onlyFreeItems=false"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetCountries

Method: GET

Path: /api/services/app/DemoUiComponents/GetCountries

Operation ID: ApiServicesAppDemouicomponentsGetcountriesGet

Tag: DemoUiComponents

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| searchTerm | query | string | No | | |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: array

Response fields

None

Example response

`json

{

"result": [

{

"name": "string",

"value": "string"

}

],

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/DemoUiComponents/GetCountries?searchTerm=string" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/DemoUiComponents/GetCountries?searchTerm=string"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

SendAndGetDate

Method: POST

Path: /api/services/app/DemoUiComponents/SendAndGetDate

Operation ID: ApiServicesAppDemouicomponentsSendandgetdatePost

Tag: DemoUiComponents

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| date | query | string (date-time) | No | | format: date-time |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: DateFieldOutput

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| date | string (date-time) | No | | format: date-time |

Example response

`json

{

"result": {

"date": "2025-01-01T00:00:00Z"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/DemoUiComponents/SendAndGetDate?date=2025-01-01T00%3A00%3A00Z" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/DemoUiComponents/SendAndGetDate?date=2025-01-01T00%3A00%3A00Z"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers

`

SendAndGetDateRange

Method: POST

Path: /api/services/app/DemoUiComponents/SendAndGetDateRange

Operation ID: ApiServicesAppDemouicomponentsSendandgetdaterangePost

Tag: DemoUiComponents

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| startDate | query | string (date-time) | No | | format: date-time |

| endDate | query | string (date-time) | No | | format: date-time |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: DateRangeFieldOutput

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| endDate | string (date-time) | No | | format: date-time |

| startDate | string (date-time) | No | | format: date-time |

Example response

`json

{

"result": {

"startDate": "2025-01-01T00:00:00Z",

"endDate": "2025-01-01T00:00:00Z"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/DemoUiComponents/SendAndGetDateRange?startDate=2025-01-01T00%3A00%3A00Z&endDate=2025-01-01T00%3A00%3A00Z" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/DemoUiComponents/SendAndGetDateRange?startDate=2025-01-01T00%3A00%3A00Z&endDate=2025-01-01T00%3A00%3A00Z"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers

`

SendAndGetDateTime

Method: POST

Path: /api/services/app/DemoUiComponents/SendAndGetDateTime

Operation ID: ApiServicesAppDemouicomponentsSendandgetdatetimePost

Tag: DemoUiComponents

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| date | query | string (date-time) | No | | format: date-time |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: DateFieldOutput

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| date | string (date-time) | No | | format: date-time |

Example response

`json

{

"result": {

"date": "2025-01-01T00:00:00Z"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/DemoUiComponents/SendAndGetDateTime?date=2025-01-01T00%3A00%3A00Z" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/DemoUiComponents/SendAndGetDateTime?date=2025-01-01T00%3A00%3A00Z"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers

`

SendAndGetDateWithText

Method: POST

Path: /api/services/app/DemoUiComponents/SendAndGetDateWithText

Operation ID: ApiServicesAppDemouicomponentsSendandgetdatewithtextPost

Tag: DemoUiComponents

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: SendAndGetDateWithTextInput

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| date | string (date-time) | No | | format: date-time |

| text | string | No | | |

Example request body

`json

{

"text": "string",

"date": "2025-01-01T00:00:00Z"

}

`

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: DateWithTextFieldOutput

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| date | string (date-time) | No | | format: date-time |

| text | string | No | | |

Example response

`json

{

"result": {

"text": "string",

"date": "2025-01-01T00:00:00Z"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/DemoUiComponents/SendAndGetDateWithText" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"text":"string","date":"2025-01-01T00:00:00Z"}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/DemoUiComponents/SendAndGetDateWithText"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"text": "string",

"date": "2025-01-01T00:00:00Z"

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

SendAndGetSelectedCountries

Method: POST

Path: /api/services/app/DemoUiComponents/SendAndGetSelectedCountries

Operation ID: ApiServicesAppDemouicomponentsSendandgetselectedcountriesPost

Tag: DemoUiComponents

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: array

Request body fields

None

Example request body

`json

[

{

"name": "string",

"value": "string"

}

]

`

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: array

Response fields

None

Example response

`json

{

"result": [

{

"name": "string",

"value": "string"

}

],

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/DemoUiComponents/SendAndGetSelectedCountries" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '[{"name":"string","value":"string"}]'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/DemoUiComponents/SendAndGetSelectedCountries"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

[

{

"name": "string",

"value": "string"

}

]

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

SendAndGetValue

Method: POST

Path: /api/services/app/DemoUiComponents/SendAndGetValue

Operation ID: ApiServicesAppDemouicomponentsSendandgetvaluePost

Tag: DemoUiComponents

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| input | query | string | No | | |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: StringOutput

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| output | string | No | | |

Example response

`json

{

"result": {

"output": "string"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/DemoUiComponents/SendAndGetValue?input=string" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/DemoUiComponents/SendAndGetValue?input=string"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers

`

GetAllSettings (HostSettings)

Method: GET

Path: /api/services/app/HostSettings/GetAllSettings

Operation ID: ApiServicesAppHostsettingsGetallsettingsGet

Tag: HostSettings

Authentication: Yes (Bearer token)

Scope: Host

Notes:- Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.

  • This endpoint is typically used in host context (platform administration). Use a host-level account/token and omit Abp.TenantId unless your deployment requires it.

Parameters

None

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: HostSettingsEditDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| email | object(EmailSettingsEditDto) | Yes | | |

| general | object(GeneralSettingsEditDto) | Yes | | |

| security | object(SecuritySettingsEditDto) | Yes | | |

| tenantManagement | object(TenantManagementSettingsEditDto) | Yes | | |

| userManagement | object(HostUserManagementSettingsEditDto) | Yes | | |

| billing | object(HostBillingSettingsEditDto) | No | | |

| externalLoginProviderSettings | object(ExternalLoginProviderSettingsEditDto) | No | | |

| otherSettings | object(OtherSettingsEditDto) | No | | |

Example response

`json

{

"result": {

"email": {

"defaultFromAddress": "string",

"defaultFromDisplayName": "string",

"smtpHost": "string"

},

"general": {

"timezone": "string",

"timezoneForComparison": "string"

},

"security": {

"allowOneConcurrentLoginPerUser": false,

"useDefaultPasswordComplexitySettings": false,

"passwordComplexity": {

"allowedMinimumLength": 0,

"requireDigit": false,

"requireLowercase": false

}

},

"tenantManagement": {

"allowSelfRegistration": false,

"isNewRegisteredTenantActiveByDefault": false,

"useCaptchaOnRegistration": false

},

"userManagement": {

"isEmailConfirmationRequiredForLogin": false,

"smsVerificationEnabled": false,

"isCookieConsentEnabled": false

}

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/HostSettings/GetAllSettings" \\

-H "Authorization: Bearer " \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/HostSettings/GetAllSettings"

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetEnabledSocialLoginSettings (HostSettings)

Method: GET

Path: /api/services/app/HostSettings/GetEnabledSocialLoginSettings

Operation ID: ApiServicesAppHostsettingsGetenabledsocialloginsettingsGet

Tag: HostSettings

Authentication: Yes (Bearer token)

Scope: Host

Notes:- Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.

  • This endpoint is typically used in host context (platform administration). Use a host-level account/token and omit Abp.TenantId unless your deployment requires it.

Parameters

None

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: ExternalLoginSettingsDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| enabledSocialLoginSettings | array | No | | |

Example response

`json

{

"result": {

"enabledSocialLoginSettings": [

"string"

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/HostSettings/GetEnabledSocialLoginSettings" \\

-H "Authorization: Bearer " \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/HostSettings/GetEnabledSocialLoginSettings"

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

SendTestEmail (HostSettings)

Method: POST

Path: /api/services/app/HostSettings/SendTestEmail

Operation ID: ApiServicesAppHostsettingsSendtestemailPost

Tag: HostSettings

Authentication: Yes (Bearer token)

Scope: Host

Notes:- Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.

  • This endpoint is typically used in host context (platform administration). Use a host-level account/token and omit Abp.TenantId unless your deployment requires it.

Parameters

None

Request body

Request body schema: SendTestEmailInput

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| emailAddress | string | Yes | | minLength: 1

maxLength: 256 |

Example request body

`json

{

"emailAddress": "user@example.com"

}

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/HostSettings/SendTestEmail" \\

-H "Authorization: Bearer " \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"emailAddress":"user@example.com"}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/HostSettings/SendTestEmail"

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; Accept = "application/json" }

$body = @'

{

"emailAddress": "user@example.com"

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

SendTestEmailSalesSummary (HostSettings)

Method: POST

Path: /api/services/app/HostSettings/SendTestEmailSalesSummary

Operation ID: ApiServicesAppHostsettingsSendtestemailsalessummaryPost

Tag: HostSettings

Authentication: Yes (Bearer token)

Scope: Host

Notes:- Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.

  • This endpoint is typically used in host context (platform administration). Use a host-level account/token and omit Abp.TenantId unless your deployment requires it.

Parameters

None

Request body

Request body schema: SendTestEmailInput

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| emailAddress | string | Yes | | minLength: 1

maxLength: 256 |

Example request body

`json

{

"emailAddress": "user@example.com"

}

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/HostSettings/SendTestEmailSalesSummary" \\

-H "Authorization: Bearer " \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"emailAddress":"user@example.com"}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/HostSettings/SendTestEmailSalesSummary"

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; Accept = "application/json" }

$body = @'

{

"emailAddress": "user@example.com"

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

UpdateAllSettings (HostSettings)

Method: PUT

Path: /api/services/app/HostSettings/UpdateAllSettings

Operation ID: ApiServicesAppHostsettingsUpdateallsettingsPut

Tag: HostSettings

Authentication: Yes (Bearer token)

Scope: Host

Notes:- Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.

  • This endpoint is typically used in host context (platform administration). Use a host-level account/token and omit Abp.TenantId unless your deployment requires it.

Parameters

None

Request body

Request body schema: HostSettingsEditDto

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| email | object(EmailSettingsEditDto) | Yes | | |

| general | object(GeneralSettingsEditDto) | Yes | | |

| security | object(SecuritySettingsEditDto) | Yes | | |

| tenantManagement | object(TenantManagementSettingsEditDto) | Yes | | |

| userManagement | object(HostUserManagementSettingsEditDto) | Yes | | |

| billing | object(HostBillingSettingsEditDto) | No | | |

| externalLoginProviderSettings | object(ExternalLoginProviderSettingsEditDto) | No | | |

| otherSettings | object(OtherSettingsEditDto) | No | | |

Example request body

`json

{

"email": {

"defaultFromAddress": "string",

"defaultFromDisplayName": "string",

"smtpHost": "string"

},

"general": {

"timezone": "string",

"timezoneForComparison": "string"

},

"security": {

"allowOneConcurrentLoginPerUser": false,

"useDefaultPasswordComplexitySettings": false,

"passwordComplexity": {

"allowedMinimumLength": 0,

"requireDigit": false,

"requireLowercase": false

}

},

"tenantManagement": {

"allowSelfRegistration": false,

"isNewRegisteredTenantActiveByDefault": false,

"useCaptchaOnRegistration": false

},

"userManagement": {

"isEmailConfirmationRequiredForLogin": false,

"smsVerificationEnabled": false,

"isCookieConsentEnabled": false

}

}

`

Response

None

Curl

`bash

curl -X PUT "https://public-api.loadgen.cloud/api/services/app/HostSettings/UpdateAllSettings" \\

-H "Authorization: Bearer " \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"email":{"defaultFromAddress":"string","defaultFromDisplayName":"string","smtpHost":"string"},"general":{"timezone":"string","timezoneForComparison":"string"},"security":{"allowOneConcurrentLoginPerUser":false,"useDefaultPasswordComplexitySettings":false,"passwordComplexity":{"allowedMinimumLength":0,"requireDigit":false,"requireLowercase":false}},"tenantManagement":{"allowSelfRegistration":false,"isNewRegisteredTenantActiveByDefault":false,"useCaptchaOnRegistration":false},"userManagement":{"isEmailConfirmationRequiredForLogin":false,"smsVerificationEnabled":false,"isCookieConsentEnabled":false}}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/HostSettings/UpdateAllSettings"

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; Accept = "application/json" }

$body = @'

{

"email": {

"defaultFromAddress": "string",

"defaultFromDisplayName": "string",

"smtpHost": "string"

},

"general": {

"timezone": "string",

"timezoneForComparison": "string"

},

"security": {

"allowOneConcurrentLoginPerUser": false,

"useDefaultPasswordComplexitySettings": false,

"passwordComplexity": {

"allowedMinimumLength": 0,

"requireDigit": false,

"requireLowercase": false

}

},

"tenantManagement": {

"allowSelfRegistration": false,

"isNewRegisteredTenantActiveByDefault": false,

"useCaptchaOnRegistration": false

},

"userManagement": {

"isEmailConfirmationRequiredForLogin": false,

"smsVerificationEnabled": false,

"isCookieConsentEnabled": false

}

}

'@

Invoke-RestMethod -Method PUT -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

CreateOrUpdateLanguage

Method: POST

Path: /api/services/app/Language/CreateOrUpdateLanguage

Operation ID: ApiServicesAppLanguageCreateorupdatelanguagePost

Tag: Language

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: CreateOrUpdateLanguageInput

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| language | object(ApplicationLanguageEditDto) | Yes | | |

Example request body

`json

{

"language": {

"name": "string",

"id": 0,

"icon": "string"

}

}

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Language/CreateOrUpdateLanguage" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"language":{"name":"string","id":0,"icon":"string"}}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Language/CreateOrUpdateLanguage"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"language": {

"name": "string",

"id": 0,

"icon": "string"

}

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

DeleteLanguage

Method: DELETE

Path: /api/services/app/Language/DeleteLanguage

Operation ID: ApiServicesAppLanguageDeletelanguageDelete

Tag: Language

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| Id | query | integer (int32) | No | | format: int32 |

Request body

None

Response

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/Language/DeleteLanguage?Id=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Language/DeleteLanguage?Id=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method DELETE -Uri $uri -Headers $headers

`

GetLanguageForEdit

Method: GET

Path: /api/services/app/Language/GetLanguageForEdit

Operation ID: ApiServicesAppLanguageGetlanguageforeditGet

Tag: Language

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| Id | query | integer (int32) | No | | format: int32 |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetLanguageForEditOutput

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| flags | array | No | | |

| language | object(ApplicationLanguageEditDto) | No | | |

| languageNames | array | No | | |

Example response

`json

{

"result": {

"language": {

"name": "string",

"id": 0,

"icon": "string"

},

"languageNames": [

{

"value": "string",

"displayText": "string",

"isSelected": false

}

],

"flags": []

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Language/GetLanguageForEdit?Id=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Language/GetLanguageForEdit?Id=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetLanguages

Method: GET

Path: /api/services/app/Language/GetLanguages

Operation ID: ApiServicesAppLanguageGetlanguagesGet

Tag: Language

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetLanguagesOutput

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| defaultLanguageName | string | No | | |

| items | array | No | | |

Example response

`json

{

"result": {

"defaultLanguageName": "string",

"items": [

{

"tenantId": 0,

"name": "string",

"displayName": "string"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Language/GetLanguages" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Language/GetLanguages"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetLanguageTexts

Method: GET

Path: /api/services/app/Language/GetLanguageTexts

Operation ID: ApiServicesAppLanguageGetlanguagetextsGet

Tag: Language

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| MaxResultCount | query | integer (int32) | No | | format: int32

min: 0

max: 2147483647 |

| SkipCount | query | integer (int32) | No | | format: int32

min: 0

max: 2147483647 |

| Sorting | query | string | No | | |

| SourceName | query | string | Yes | | maxLength: 128 |

| BaseLanguageName | query | string | No | | minLength: 0

maxLength: 128 |

| TargetLanguageName | query | string | Yes | | minLength: 2

maxLength: 128 |

| TargetValueFilter | query | string | No | | |

| FilterText | query | string | No | | |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: LanguageTextListDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| items | array | No | | |

| totalCount | integer (int32) | No | | format: int32 |

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"key": "string",

"baseValue": "string",

"targetValue": "string"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Language/GetLanguageTexts?SourceName=string&TargetLanguageName=string" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Language/GetLanguageTexts?SourceName=string&TargetLanguageName=string"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

SetDefaultLanguage

Method: POST

Path: /api/services/app/Language/SetDefaultLanguage

Operation ID: ApiServicesAppLanguageSetdefaultlanguagePost

Tag: Language

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: SetDefaultLanguageInput

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| name | string | Yes | | minLength: 0

maxLength: 128 |

Example request body

`json

{

"name": "string"

}

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Language/SetDefaultLanguage" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"name":"string"}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Language/SetDefaultLanguage"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"name": "string"

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

UpdateLanguageText

Method: PUT

Path: /api/services/app/Language/UpdateLanguageText

Operation ID: ApiServicesAppLanguageUpdatelanguagetextPut

Tag: Language

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: UpdateLanguageTextInput

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| key | string | Yes | | minLength: 0

maxLength: 256 |

| languageName | string | Yes | | minLength: 0

maxLength: 128 |

| sourceName | string | Yes | | minLength: 0

maxLength: 128 |

| value | string | Yes | | minLength: 0

maxLength: 67108864 |

Example request body

`json

{

"key": "string",

"languageName": "string",

"sourceName": "string",

"value": "string"

}

`

Response

None

Curl

`bash

curl -X PUT "https://public-api.loadgen.cloud/api/services/app/Language/UpdateLanguageText" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"key":"string","languageName":"string","sourceName":"string","value":"string"}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Language/UpdateLanguageText"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"key": "string",

"languageName": "string",

"sourceName": "string",

"value": "string"

}

'@

Invoke-RestMethod -Method PUT -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

ClearCustomCss

Method: POST

Path: /api/services/app/TenantSettings/ClearCustomCss

Operation ID: ApiServicesAppTenantsettingsClearcustomcssPost

Tag: TenantSettings

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/TenantSettings/ClearCustomCss" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/TenantSettings/ClearCustomCss"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers

`

ClearDarkLogo

Method: POST

Path: /api/services/app/TenantSettings/ClearDarkLogo

Operation ID: ApiServicesAppTenantsettingsCleardarklogoPost

Tag: TenantSettings

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/TenantSettings/ClearDarkLogo" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/TenantSettings/ClearDarkLogo"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers

`

ClearLightLogo

Method: POST

Path: /api/services/app/TenantSettings/ClearLightLogo

Operation ID: ApiServicesAppTenantsettingsClearlightlogoPost

Tag: TenantSettings

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/TenantSettings/ClearLightLogo" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/TenantSettings/ClearLightLogo"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers

`

GetAllSettings (TenantSettings)

Method: GET

Path: /api/services/app/TenantSettings/GetAllSettings

Operation ID: ApiServicesAppTenantsettingsGetallsettingsGet

Tag: TenantSettings

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: TenantSettingsEditDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| security | object(SecuritySettingsEditDto) | Yes | | |

| userManagement | object(TenantUserManagementSettingsEditDto) | Yes | | |

| billing | object(TenantBillingSettingsEditDto) | No | | |

| email | object(TenantEmailSettingsEditDto) | No | | |

| externalLoginProviderSettings | object(ExternalLoginProviderSettingsEditDto) | No | | |

| general | object(GeneralSettingsEditDto) | No | | |

| ldap | object(LdapSettingsEditDto) | No | | |

| otherSettings | object(TenantOtherSettingsEditDto) | No | | |

Example response

`json

{

"result": {

"security": {

"allowOneConcurrentLoginPerUser": false,

"useDefaultPasswordComplexitySettings": false,

"passwordComplexity": {

"allowedMinimumLength": 0,

"requireDigit": false,

"requireLowercase": false

}

},

"userManagement": {

"allowSelfRegistration": false,

"isNewRegisteredUserActiveByDefault": false,

"isEmailConfirmationRequiredForLogin": false

},

"general": {

"timezone": "string",

"timezoneForComparison": "string"

}

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/TenantSettings/GetAllSettings" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/TenantSettings/GetAllSettings"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetEnabledSocialLoginSettings (TenantSettings)

Method: GET

Path: /api/services/app/TenantSettings/GetEnabledSocialLoginSettings

Operation ID: ApiServicesAppTenantsettingsGetenabledsocialloginsettingsGet

Tag: TenantSettings

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: ExternalLoginSettingsDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| enabledSocialLoginSettings | array | No | | |

Example response

`json

{

"result": {

"enabledSocialLoginSettings": [

"string"

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/TenantSettings/GetEnabledSocialLoginSettings" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/TenantSettings/GetEnabledSocialLoginSettings"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

SendTestEmail (TenantSettings)

Method: POST

Path: /api/services/app/TenantSettings/SendTestEmail

Operation ID: ApiServicesAppTenantsettingsSendtestemailPost

Tag: TenantSettings

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: SendTestEmailInput

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| emailAddress | string | Yes | | minLength: 1

maxLength: 256 |

Example request body

`json

{

"emailAddress": "user@example.com"

}

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/TenantSettings/SendTestEmail" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"emailAddress":"user@example.com"}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/TenantSettings/SendTestEmail"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"emailAddress": "user@example.com"

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

SendTestEmailSalesSummary (TenantSettings)

Method: POST

Path: /api/services/app/TenantSettings/SendTestEmailSalesSummary

Operation ID: ApiServicesAppTenantsettingsSendtestemailsalessummaryPost

Tag: TenantSettings

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: SendTestEmailInput

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| emailAddress | string | Yes | | minLength: 1

maxLength: 256 |

Example request body

`json

{

"emailAddress": "user@example.com"

}

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/TenantSettings/SendTestEmailSalesSummary" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"emailAddress":"user@example.com"}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/TenantSettings/SendTestEmailSalesSummary"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"emailAddress": "user@example.com"

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

UpdateAllSettings (TenantSettings)

Method: PUT

Path: /api/services/app/TenantSettings/UpdateAllSettings

Operation ID: ApiServicesAppTenantsettingsUpdateallsettingsPut

Tag: TenantSettings

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: TenantSettingsEditDto

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| security | object(SecuritySettingsEditDto) | Yes | | |

| userManagement | object(TenantUserManagementSettingsEditDto) | Yes | | |

| billing | object(TenantBillingSettingsEditDto) | No | | |

| email | object(TenantEmailSettingsEditDto) | No | | |

| externalLoginProviderSettings | object(ExternalLoginProviderSettingsEditDto) | No | | |

| general | object(GeneralSettingsEditDto) | No | | |

| ldap | object(LdapSettingsEditDto) | No | | |

| otherSettings | object(TenantOtherSettingsEditDto) | No | | |

Example request body

`json

{

"security": {

"allowOneConcurrentLoginPerUser": false,

"useDefaultPasswordComplexitySettings": false,

"passwordComplexity": {

"allowedMinimumLength": 0,

"requireDigit": false,

"requireLowercase": false

}

},

"userManagement": {

"allowSelfRegistration": false,

"isNewRegisteredUserActiveByDefault": false,

"isEmailConfirmationRequiredForLogin": false

},

"general": {

"timezone": "string",

"timezoneForComparison": "string"

}

}

`

Response

None

Curl

`bash

curl -X PUT "https://public-api.loadgen.cloud/api/services/app/TenantSettings/UpdateAllSettings" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"security":{"allowOneConcurrentLoginPerUser":false,"useDefaultPasswordComplexitySettings":false,"passwordComplexity":{"allowedMinimumLength":0,"requireDigit":false,"requireLowercase":false}},"userManagement":{"allowSelfRegistration":false,"isNewRegisteredUserActiveByDefault":false,"isEmailConfirmationRequiredForLogin":false},"general":{"timezone":"string","timezoneForComparison":"string"}}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/TenantSettings/UpdateAllSettings"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"security": {

"allowOneConcurrentLoginPerUser": false,

"useDefaultPasswordComplexitySettings": false,

"passwordComplexity": {

"allowedMinimumLength": 0,

"requireDigit": false,

"requireLowercase": false

}

},

"userManagement": {

"allowSelfRegistration": false,

"isNewRegisteredUserActiveByDefault": false,

"isEmailConfirmationRequiredForLogin": false

},

"general": {

"timezone": "string",

"timezoneForComparison": "string"

}

}

'@

Invoke-RestMethod -Method PUT -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

GetCurrentTimeZone

Method: GET

Path: /api/services/app/Timing/GetCurrentTimeZone

Operation ID: ApiServicesAppTimingGetcurrenttimezoneGet

Tag: Timing

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: NameValueDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| name | string | No | | |

| value | string | No | | |

Example response

`json

{

"result": {

"name": "string",

"value": "string"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Timing/GetCurrentTimeZone" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Timing/GetCurrentTimeZone"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetTimezoneComboboxItems

Method: GET

Path: /api/services/app/Timing/GetTimezoneComboboxItems

Operation ID: ApiServicesAppTimingGettimezonecomboboxitemsGet

Tag: Timing

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| SelectedTimezoneId | query | string | No | | |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: array

Response fields

None

Example response

`json

{

"result": [

{

"value": "string",

"displayText": "string",

"isSelected": false

}

],

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Timing/GetTimezoneComboboxItems?SelectedTimezoneId=string" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Timing/GetTimezoneComboboxItems?SelectedTimezoneId=string"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetTimezones

Method: GET

Path: /api/services/app/Timing/GetTimezones

Operation ID: ApiServicesAppTimingGettimezonesGet

Tag: Timing

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| DefaultTimezoneScope | query | enum(1 | 2 | 4 | 7) | No | | format: int32

enum: 1, 2, 4, 7 |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: NameValueDtoListResultDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| items | array | No | | |

Example response

`json

{

"result": {

"items": [

{

"name": "string",

"value": "string"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Timing/GetTimezones?DefaultTimezoneScope=1" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Timing/GetTimezones?DefaultTimezoneScope=1"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetTimezoneUtcOffset

Method: GET

Path: /api/services/app/Timing/GetTimezoneUtcOffset

Operation ID: ApiServicesAppTimingGettimezoneutcoffsetGet

Tag: Timing

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: number (double)

Response fields

None

Example response

`json

{

"result": 0,

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Timing/GetTimezoneUtcOffset" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Timing/GetTimezoneUtcOffset"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

SetTimezone

Method: POST

Path: /api/services/app/Timing/SetTimezone

Operation ID: ApiServicesAppTimingSettimezonePost

Tag: Timing

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| timezoneCode | query | string | No | | |

Request body

None

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Timing/SetTimezone?timezoneCode=string" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Timing/SetTimezone?timezoneCode=string"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers

`

ChangeDarkModeOfCurrentTheme

Method: POST

Path: /api/services/app/UiCustomizationSettings/ChangeDarkModeOfCurrentTheme

Operation ID: ApiServicesAppUicustomizationsettingsChangedarkmodeofcurrentthemePost

Tag: UiCustomizationSettings

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| isDarkModeActive | query | boolean | No | | |

Request body

None

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/UiCustomizationSettings/ChangeDarkModeOfCurrentTheme?isDarkModeActive=false" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/UiCustomizationSettings/ChangeDarkModeOfCurrentTheme?isDarkModeActive=false"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers

`

ChangeThemeWithDefaultValues

Method: POST

Path: /api/services/app/UiCustomizationSettings/ChangeThemeWithDefaultValues

Operation ID: ApiServicesAppUicustomizationsettingsChangethemewithdefaultvaluesPost

Tag: UiCustomizationSettings

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| themeName | query | string | No | | |

Request body

None

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/UiCustomizationSettings/ChangeThemeWithDefaultValues?themeName=string" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/UiCustomizationSettings/ChangeThemeWithDefaultValues?themeName=string"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers

`

GetUiManagementSettings

Method: GET

Path: /api/services/app/UiCustomizationSettings/GetUiManagementSettings

Operation ID: ApiServicesAppUicustomizationsettingsGetuimanagementsettingsGet

Tag: UiCustomizationSettings

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: array

Response fields

None

Example response

`json

{

"result": [

{

"theme": "string",

"layout": {

"layoutType": "string",

"darkMode": false

},

"header": {

"desktopFixedHeader": false,

"mobileFixedHeader": false,

"minimizeDesktopHeaderType": "string"

}

}

],

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/UiCustomizationSettings/GetUiManagementSettings" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/UiCustomizationSettings/GetUiManagementSettings"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

UpdateDefaultUiManagementSettings

Method: PUT

Path: /api/services/app/UiCustomizationSettings/UpdateDefaultUiManagementSettings

Operation ID: ApiServicesAppUicustomizationsettingsUpdatedefaultuimanagementsettingsPut

Tag: UiCustomizationSettings

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: ThemeSettingsDto

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| footer | object(ThemeFooterSettingsDto) | No | | |

| header | object(ThemeHeaderSettingsDto) | No | | |

| layout | object(ThemeLayoutSettingsDto) | No | | |

| menu | object(ThemeMenuSettingsDto) | No | | |

| subHeader | object(ThemeSubHeaderSettingsDto) | No | | |

| theme | string | No | | |

| toolbar | object(ThemeToolbarSettingsDto) | No | | |

Example request body

`json

{

"theme": "string",

"layout": {

"layoutType": "string",

"darkMode": false

},

"header": {

"desktopFixedHeader": false,

"mobileFixedHeader": false,

"minimizeDesktopHeaderType": "string"

}

}

`

Response

None

Curl

`bash

curl -X PUT "https://public-api.loadgen.cloud/api/services/app/UiCustomizationSettings/UpdateDefaultUiManagementSettings" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"theme":"string","layout":{"layoutType":"string","darkMode":false},"header":{"desktopFixedHeader":false,"mobileFixedHeader":false,"minimizeDesktopHeaderType":"string"}}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/UiCustomizationSettings/UpdateDefaultUiManagementSettings"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"theme": "string",

"layout": {

"layoutType": "string",

"darkMode": false

},

"header": {

"desktopFixedHeader": false,

"mobileFixedHeader": false,

"minimizeDesktopHeaderType": "string"

}

}

'@

Invoke-RestMethod -Method PUT -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

UpdateUiManagementSettings

Method: PUT

Path: /api/services/app/UiCustomizationSettings/UpdateUiManagementSettings

Operation ID: ApiServicesAppUicustomizationsettingsUpdateuimanagementsettingsPut

Tag: UiCustomizationSettings

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: ThemeSettingsDto

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| footer | object(ThemeFooterSettingsDto) | No | | |

| header | object(ThemeHeaderSettingsDto) | No | | |

| layout | object(ThemeLayoutSettingsDto) | No | | |

| menu | object(ThemeMenuSettingsDto) | No | | |

| subHeader | object(ThemeSubHeaderSettingsDto) | No | | |

| theme | string | No | | |

| toolbar | object(ThemeToolbarSettingsDto) | No | | |

Example request body

`json

{

"theme": "string",

"layout": {

"layoutType": "string",

"darkMode": false

},

"header": {

"desktopFixedHeader": false,

"mobileFixedHeader": false,

"minimizeDesktopHeaderType": "string"

}

}

`

Response

None

Curl

`bash

curl -X PUT "https://public-api.loadgen.cloud/api/services/app/UiCustomizationSettings/UpdateUiManagementSettings" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"theme":"string","layout":{"layoutType":"string","darkMode":false},"header":{"desktopFixedHeader":false,"mobileFixedHeader":false,"minimizeDesktopHeaderType":"string"}}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/UiCustomizationSettings/UpdateUiManagementSettings"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"theme": "string",

"layout": {

"layoutType": "string",

"darkMode": false

},

"header": {

"desktopFixedHeader": false,

"mobileFixedHeader": false,

"minimizeDesktopHeaderType": "string"

}

}

'@

Invoke-RestMethod -Method PUT -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

UseSystemDefaultSettings

Method: POST

Path: /api/services/app/UiCustomizationSettings/UseSystemDefaultSettings

Operation ID: ApiServicesAppUicustomizationsettingsUsesystemdefaultsettingsPost

Tag: UiCustomizationSettings

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/UiCustomizationSettings/UseSystemDefaultSettings" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/UiCustomizationSettings/UseSystemDefaultSettings"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers

`

Was this article helpful?
0 out of 0 found this helpful