Cloud API - Alerts and Triggers

Updated

Cloud API - Alerts and Triggers

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

This article documents alerting endpoints (alerts, alert triggers, tests, notifications, and related supporting services).

CreateOrEditAlert

Method: POST

Path: /api/services/app/Alert/CreateOrEditAlert

Operation ID: ApiServicesAppAlertCreateoreditalertPost

Tag: Alert

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: CreateOrEditAlertDto

Request body fields

| Field | Type | Required | Description | Notes |

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

| configurationType | enum(0 \| 1) | No | | format: int32

enum: 0, 1 |

| filter | object(BaseFilterRuleDto) | No | | |

| filterJson | string | No | | |

| id | string (uuid) | No | | format: uuid |

| title | string | No | | |

| trigger | object(BaseAlertTriggerDto) | No | | |

| type | enum(0 \| 1 \| 2 \| 3 \| 4) | No | | format: int32

enum: 0, 1, 2, 3, 4 |

Example request body

`json

{

"title": "string",

"trigger": {

"type": 0,

"configurationType": 0,

"title": "string"

},

"type": 0

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"title":"string","trigger":{"type":0,"configurationType":0,"title":"string"},"type":0}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Alert/CreateOrEditAlert"

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"title": "string",

"trigger": {

"type": 0,

"configurationType": 0,

"title": "string"

},

"type": 0

}

'@

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

`

CreateOrEditAlertTrigger

Method: POST

Path: /api/services/app/Alert/CreateOrEditAlertTrigger

Operation ID: ApiServicesAppAlertCreateoreditalerttriggerPost

Tag: Alert

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: BaseAlertTriggerDto

Request body fields

| Field | Type | Required | Description | Notes |

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

| configurationType | enum(0 \| 1) | No | | format: int32

enum: 0, 1 |

| id | string (uuid) | No | | format: uuid |

| tenant | object(Tenant) | No | | |

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

| title | string | No | | |

| type | enum(0 \| 1 \| 2 \| 3) | No | | format: int32

enum: 0, 1, 2, 3 |

Example request body

`json

{

"type": 0,

"configurationType": 0,

"title": "string"

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"type":0,"configurationType":0,"title":"string"}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Alert/CreateOrEditAlertTrigger"

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"type": 0,

"configurationType": 0,

"title": "string"

}

'@

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

`

Delete

Method: DELETE

Path: /api/services/app/Alert/Delete

Operation ID: ApiServicesAppAlertDeleteDelete

Tag: Alert

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 |

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

| alertId | query | string (uuid) | No | | format: uuid |

Request body

None

Response

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/Alert/Delete?alertId=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Alert/Delete?alertId=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

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

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

`

DeleteAlert

Method: DELETE

Path: /api/services/app/Alert/DeleteAlert

Operation ID: ApiServicesAppAlertDeletealertDelete

Tag: Alert

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 | string | No | | |

Request body

None

Response

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/Alert/DeleteAlert?id=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/Alert/DeleteAlert?id=string"

$tenantId = 12345

$accessToken = ""

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

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

`

DeleteAlertTrigger

Method: DELETE

Path: /api/services/app/Alert/DeleteAlertTrigger

Operation ID: ApiServicesAppAlertDeletealerttriggerDelete

Tag: Alert

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 | string | No | | |

Request body

None

Response

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/Alert/DeleteAlertTrigger?id=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/Alert/DeleteAlertTrigger?id=string"

$tenantId = 12345

$accessToken = ""

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

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

`

Get

Method: GET

Path: /api/services/app/Alert/Get

Operation ID: ApiServicesAppAlertGetGet

Tag: Alert

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 |

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

| alertId | query | string (uuid) | No | | format: uuid |

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: GetAlertDto

Response fields

| Field | Type | Required | Description | Notes |

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

| configurationType | enum(0 \| 1) | No | | format: int32

enum: 0, 1 |

| filter | object | No | | |

| id | string (uuid) | No | | format: uuid |

| title | string | No | | |

| trigger | object(BaseAlertTrigger) | No | | |

| type | enum(0 \| 1 \| 2 \| 3 \| 4) | No | | format: int32

enum: 0, 1, 2, 3, 4 |

Example response

`json

{

"result": {

"title": "string",

"trigger": {

"type": 0,

"configurationType": 0,

"title": "string"

},

"type": 0

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Alert/Get?alertId=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Alert/Get?alertId=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

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

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

`

GetAlertTrigger

Method: GET

Path: /api/services/app/Alert/GetAlertTrigger

Operation ID: ApiServicesAppAlertGetalerttriggerGet

Tag: Alert

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 |

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

| alertTriggerId | query | string (uuid) | No | | format: uuid |

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: object

Response fields

None

Example response

`json

{

"result": {

"key": "value"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Alert/GetAlertTrigger?alertTriggerId=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Alert/GetAlertTrigger?alertTriggerId=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

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

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

`

GetAll (Alert)

Method: GET

Path: /api/services/app/Alert/GetAll

Operation ID: ApiServicesAppAlertGetallGet

Tag: Alert

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 |

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

| Title | query | string | No | | |

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

| Sorting | query | string | No | | |

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

min: 0

max: 2147483647 |

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

min: 1

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: GetAllAlertDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

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

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"id": "00000000-0000-0000-0000-000000000000",

"title": "string",

"trigger": {

"title": "string"

}

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Alert/GetAll?Title=string&TenantId=0&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/Alert/GetAll?Title=string&TenantId=0&Sorting=string"

$tenantId = 12345

$accessToken = ""

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

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

`

GetAllAlertTriggers

Method: GET

Path: /api/services/app/Alert/GetAllAlertTriggers

Operation ID: ApiServicesAppAlertGetallalerttriggersGet

Tag: Alert

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 |

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

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

| Sorting | query | string | No | | |

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

min: 0

max: 2147483647 |

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

min: 1

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: GetAllAlertTriggerDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

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

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"id": "00000000-0000-0000-0000-000000000000",

"type": 0,

"configurationType": 0

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Alert/GetAllAlertTriggers?TenantId=0&Sorting=string&SkipCount=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/Alert/GetAllAlertTriggers?TenantId=0&Sorting=string&SkipCount=0"

$tenantId = 12345

$accessToken = ""

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

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

`

GetAllAlertTriggersAsBase

Method: GET

Path: /api/services/app/Alert/GetAllAlertTriggersAsBase

Operation ID: ApiServicesAppAlertGetallalerttriggersasbaseGet

Tag: Alert

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": [

{

"type": 0,

"configurationType": 0,

"title": "string"

}

],

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Alert/GetAllAlertTriggersAsBase"

$tenantId = 12345

$accessToken = ""

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

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

`

GetDuafData

Method: GET

Path: /api/services/app/Alert/GetDuafData

Operation ID: ApiServicesAppAlertGetduafdataGet

Tag: Alert

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 |

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

| selector | 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": [

"string"

],

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Alert/GetDuafData?selector=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/Alert/GetDuafData?selector=string"

$tenantId = 12345

$accessToken = ""

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

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

`

GetPMData

Method: GET

Path: /api/services/app/Alert/GetPMData

Operation ID: ApiServicesAppAlertGetpmdataGet

Tag: Alert

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 |

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

| selector | 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": [

"string"

],

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Alert/GetPMData?selector=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/Alert/GetPMData?selector=string"

$tenantId = 12345

$accessToken = ""

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

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

`

TestFilter

Method: POST

Path: /api/services/app/Alert/TestFilter

Operation ID: ApiServicesAppAlertTestfilterPost

Tag: Alert

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: FilterRuleDto

Request body fields

| Field | Type | Required | Description | Notes |

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

| field | string | No | | |

| id | string (uuid) | No | | format: uuid |

| operator | enum(0 \| 1 \| 2 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10 \| 11 \| 12 \| 13 \| 14 \| 15 \| 16 \| 17 \| 18) | No | | format: int32

enum: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18 |

| type | enum(0 \| 1) | No | | format: int32

enum: 0, 1 |

| value | unknown | No | | |

Example request body

`json

{

"type": 0,

"operator": 0,

"field": "string"

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"type":0,"operator":0,"field":"string"}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Alert/TestFilter"

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"type": 0,

"operator": 0,

"field": "string"

}

'@

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

`

TestGroup

Method: POST

Path: /api/services/app/Alert/TestGroup

Operation ID: ApiServicesAppAlertTestgroupPost

Tag: Alert

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: GroupFilterRuleDto

Request body fields

| Field | Type | Required | Description | Notes |

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

| children | array | No | | |

| id | string (uuid) | No | | format: uuid |

| operator | enum(0 \| 1 \| 2 \| 3) | No | | format: int32

enum: 0, 1, 2, 3 |

| type | enum(0 \| 1) | No | | format: int32

enum: 0, 1 |

Example request body

`json

{

"type": 0,

"operator": 0,

"children": [

{

"id": "00000000-0000-0000-0000-000000000000"

}

]

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"type":0,"operator":0,"children":[{"id":"00000000-0000-0000-0000-000000000000"}]}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Alert/TestGroup"

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"type": 0,

"operator": 0,

"children": [

{

"id": "00000000-0000-0000-0000-000000000000"

}

]

}

'@

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

`

TestTriggerEmail

Method: POST

Path: /api/services/app/Alert/TestTriggerEmail

Operation ID: ApiServicesAppAlertTesttriggeremailPost

Tag: Alert

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: EmailAlertTriggerDto

Request body fields

| Field | Type | Required | Description | Notes |

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

| bccEmails | array | No | | |

| bccEmailsString | string | No | | |

| ccEmails | array | No | | |

| ccEmailsString | string | No | | |

| configurationType | enum(0 \| 1) | No | | format: int32

enum: 0, 1 |

| id | string (uuid) | No | | format: uuid |

| message | string | No | | |

| subject | string | No | | |

| tenant | object(Tenant) | No | | |

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

| title | string | No | | |

| toEmail | string | No | | |

| type | enum(0 \| 1 \| 2 \| 3) | No | | format: int32

enum: 0, 1, 2, 3 |

Example request body

`json

{

"type": 0,

"toEmail": "user@example.com",

"subject": "string"

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"type":0,"toEmail":"user@example.com","subject":"string"}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Alert/TestTriggerEmail"

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"type": 0,

"toEmail": "user@example.com",

"subject": "string"

}

'@

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

`

TestTriggerSMS

Method: POST

Path: /api/services/app/Alert/TestTriggerSMS

Operation ID: ApiServicesAppAlertTesttriggersmsPost

Tag: Alert

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: SMSAlertTriggerDto

Request body fields

| Field | Type | Required | Description | Notes |

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

| configurationType | enum(0 \| 1) | No | | format: int32

enum: 0, 1 |

| id | string (uuid) | No | | format: uuid |

| messageBody | string | No | | |

| phoneNumbers | array | No | | |

| phoneNumbersString | string | No | | |

| tenant | object(Tenant) | No | | |

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

| title | string | No | | |

| type | enum(0 \| 1 \| 2 \| 3) | No | | format: int32

enum: 0, 1, 2, 3 |

Example request body

`json

{

"type": 0,

"messageBody": "string",

"phoneNumbersString": "string"

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"type":0,"messageBody":"string","phoneNumbersString":"string"}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Alert/TestTriggerSMS"

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"type": 0,

"messageBody": "string",

"phoneNumbersString": "string"

}

'@

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

`

TestTriggerType

Method: POST

Path: /api/services/app/Alert/TestTriggerType

Operation ID: ApiServicesAppAlertTesttriggertypePost

Tag: Alert

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: BaseAlertTriggerTypeDto

Request body fields

None

Example request body

`json

0

`

Response

None

Curl

`bash

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

-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/Alert/TestTriggerType"

$tenantId = 12345

$accessToken = ""

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

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

`

TestTriggerWhatsApp

Method: POST

Path: /api/services/app/Alert/TestTriggerWhatsApp

Operation ID: ApiServicesAppAlertTesttriggerwhatsappPost

Tag: Alert

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: WhatsAppAlertTriggerDto

Request body fields

| Field | Type | Required | Description | Notes |

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

| configurationType | enum(0 \| 1) | No | | format: int32

enum: 0, 1 |

| id | string (uuid) | No | | format: uuid |

| phoneNumber | string | No | | |

| senderName | string | No | | |

| tenant | object(Tenant) | No | | |

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

| title | string | No | | |

| type | enum(0 \| 1 \| 2 \| 3) | No | | format: int32

enum: 0, 1, 2, 3 |

Example request body

`json

{

"type": 0,

"phoneNumber": "string",

"senderName": "string"

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"type":0,"phoneNumber":"string","senderName":"string"}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Alert/TestTriggerWhatsApp"

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"type": 0,

"phoneNumber": "string",

"senderName": "string"

}

'@

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

`

TestTriggeWebhook

Method: POST

Path: /api/services/app/Alert/TestTriggeWebhook

Operation ID: ApiServicesAppAlertTesttriggewebhookPost

Tag: Alert

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: WebhookAlertTriggerDto

Request body fields

| Field | Type | Required | Description | Notes |

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

| bodyTemplate | string | No | | |

| configurationType | enum(0 \| 1) | No | | format: int32

enum: 0, 1 |

| headers | string | No | | |

| id | string (uuid) | No | | format: uuid |

| method | string | No | | |

| params | string | No | | |

| tenant | object(Tenant) | No | | |

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

| title | string | No | | |

| type | enum(0 \| 1 \| 2 \| 3) | No | | format: int32

enum: 0, 1, 2, 3 |

| url | string | No | | |

Example request body

`json

{

"type": 0,

"url": "https://example.com",

"method": "string"

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"type":0,"url":"https://example.com","method":"string"}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Alert/TestTriggeWebhook"

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"type": 0,

"url": "https://example.com",

"method": "string"

}

'@

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

`

CreateOrEdit

Method: POST

Path: /api/services/app/ModalInformationService/CreateOrEdit

Operation ID: ApiServicesAppModalinformationserviceCreateoreditPost

Tag: ModalInformationService

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: CreateOrEditModalInformationDto

Request body fields

| Field | Type | Required | Description | Notes |

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

| description | string | No | | |

| id | string (uuid) | No | | format: uuid |

| modalName | string | No | | |

| supportURL | string | No | | |

Example request body

`json

{

"modalName": "string",

"description": "string",

"supportURL": "https://example.com"

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"modalName":"string","description":"string","supportURL":"https://example.com"}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/ModalInformationService/CreateOrEdit"

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"modalName": "string",

"description": "string",

"supportURL": "https://example.com"

}

'@

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

`

GetAll (ModalInformationService)

Method: GET

Path: /api/services/app/ModalInformationService/GetAll

Operation ID: ApiServicesAppModalinformationserviceGetallGet

Tag: ModalInformationService

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 |

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

| Filter | query | string | No | | |

| Sorting | query | string | No | | |

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

min: 0

max: 2147483647 |

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

min: 1

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: GetModalInformationForOverviewDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

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

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"modalName": "string",

"description": "string",

"supportURL": "https://example.com"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/ModalInformationService/GetAll?Filter=string&Sorting=string&SkipCount=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/ModalInformationService/GetAll?Filter=string&Sorting=string&SkipCount=0"

$tenantId = 12345

$accessToken = ""

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

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

`

GetModalInformation

Method: GET

Path: /api/services/app/ModalInformationService/GetModalInformation

Operation ID: ApiServicesAppModalinformationserviceGetmodalinformationGet

Tag: ModalInformationService

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 |

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

| modalName | 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: ModalInformationDto

Response fields

| Field | Type | Required | Description | Notes |

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

| description | string | No | | |

| id | string (uuid) | No | | format: uuid |

| supportURL | string | No | | |

Example response

`json

{

"result": {

"description": "string",

"supportURL": "https://example.com",

"id": "00000000-0000-0000-0000-000000000000"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/ModalInformationService/GetModalInformation?modalName=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/ModalInformationService/GetModalInformation?modalName=string"

$tenantId = 12345

$accessToken = ""

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

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

`

GetModalInformationForEdit

Method: GET

Path: /api/services/app/ModalInformationService/GetModalInformationForEdit

Operation ID: ApiServicesAppModalinformationserviceGetmodalinformationforeditGet

Tag: ModalInformationService

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 | string (uuid) | No | | format: uuid |

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: GetModalInformationForEditDto

Response fields

| Field | Type | Required | Description | Notes |

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

| description | string | No | | |

| id | string (uuid) | No | | format: uuid |

| modalName | string | No | | |

| supportURL | string | No | | |

Example response

`json

{

"result": {

"modalName": "string",

"description": "string",

"supportURL": "https://example.com"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/ModalInformationService/GetModalInformationForEdit?Id=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/ModalInformationService/GetModalInformationForEdit?Id=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

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

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

`

GetModalInformationForView

Method: GET

Path: /api/services/app/ModalInformationService/GetModalInformationForView

Operation ID: ApiServicesAppModalinformationserviceGetmodalinformationforviewGet

Tag: ModalInformationService

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 | string (uuid) | No | | format: uuid |

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: GetModalInformationForViewDto

Response fields

| Field | Type | Required | Description | Notes |

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

| description | string | No | | |

| id | string (uuid) | No | | format: uuid |

| modalName | string | No | | |

| supportURL | string | No | | |

Example response

`json

{

"result": {

"modalName": "string",

"description": "string",

"supportURL": "https://example.com"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/ModalInformationService/GetModalInformationForView?id=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/ModalInformationService/GetModalInformationForView?id=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

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

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

`

CreateMassNotification

Method: POST

Path: /api/services/app/Notification/CreateMassNotification

Operation ID: ApiServicesAppNotificationCreatemassnotificationPost

Tag: Notification

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: CreateMassNotificationInput

Request body fields

| Field | Type | Required | Description | Notes |

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

| message | string | No | | |

| organizationUnitIds | array | No | | |

| severity | enum(0 \| 1 \| 2 \| 3 \| 4) | No | | format: int32

enum: 0, 1, 2, 3, 4 |

| targetNotifiers | array | No | | |

| userIds | array | No | | |

Example request body

`json

{

"message": "string",

"severity": 0,

"userIds": [

0

]

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"message":"string","severity":0,"userIds":[0]}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Notification/CreateMassNotification"

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"message": "string",

"severity": 0,

"userIds": [

0

]

}

'@

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

`

CreateNewVersionReleasedNotification

Method: POST

Path: /api/services/app/Notification/CreateNewVersionReleasedNotification

Operation ID: ApiServicesAppNotificationCreatenewversionreleasednotificationPost

Tag: Notification

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/Notification/CreateNewVersionReleasedNotification" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Notification/CreateNewVersionReleasedNotification"

$tenantId = 12345

$accessToken = ""

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

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

`

DeleteAllUserNotifications

Method: DELETE

Path: /api/services/app/Notification/DeleteAllUserNotifications

Operation ID: ApiServicesAppNotificationDeleteallusernotificationsDelete

Tag: Notification

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 |

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

| State | query | enum(0 | 1) | No | | format: int32

enum: 0, 1 |

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

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

Request body

None

Response

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/Notification/DeleteAllUserNotifications?State=0&StartDate=2025-01-01T00%3A00%3A00Z&EndDate=2025-01-01T00%3A00%3A00Z" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Notification/DeleteAllUserNotifications?State=0&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 DELETE -Uri $uri -Headers $headers

`

DeleteNotification

Method: DELETE

Path: /api/services/app/Notification/DeleteNotification

Operation ID: ApiServicesAppNotificationDeletenotificationDelete

Tag: Notification

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 | string (uuid) | No | | format: uuid |

Request body

None

Response

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/Notification/DeleteNotification?Id=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Notification/DeleteNotification?Id=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

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

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

`

GetAllNotifiers

Method: GET

Path: /api/services/app/Notification/GetAllNotifiers

Operation ID: ApiServicesAppNotificationGetallnotifiersGet

Tag: Notification

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": [

"string"

],

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Notification/GetAllNotifiers"

$tenantId = 12345

$accessToken = ""

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

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

`

GetAllOrganizationUnitForLookupTable

Method: GET

Path: /api/services/app/Notification/GetAllOrganizationUnitForLookupTable

Operation ID: ApiServicesAppNotificationGetallorganizationunitforlookuptableGet

Tag: Notification

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 |

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

| Filter | query | string | No | | |

| Sorting | query | string | No | | |

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

min: 0

max: 2147483647 |

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

min: 1

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: MassNotificationOrganizationUnitLookupTableDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

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

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"id": 0,

"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/Notification/GetAllOrganizationUnitForLookupTable?Filter=string&Sorting=string&SkipCount=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/Notification/GetAllOrganizationUnitForLookupTable?Filter=string&Sorting=string&SkipCount=0"

$tenantId = 12345

$accessToken = ""

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

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

`

GetAllUserForLookupTable

Method: GET

Path: /api/services/app/Notification/GetAllUserForLookupTable

Operation ID: ApiServicesAppNotificationGetalluserforlookuptableGet

Tag: Notification

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 |

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

| Filter | query | string | No | | |

| Sorting | query | string | No | | |

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

min: 0

max: 2147483647 |

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

min: 1

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: MassNotificationUserLookupTableDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

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

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"id": 0,

"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/Notification/GetAllUserForLookupTable?Filter=string&Sorting=string&SkipCount=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/Notification/GetAllUserForLookupTable?Filter=string&Sorting=string&SkipCount=0"

$tenantId = 12345

$accessToken = ""

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

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

`

GetNotificationSettings

Method: GET

Path: /api/services/app/Notification/GetNotificationSettings

Operation ID: ApiServicesAppNotificationGetnotificationsettingsGet

Tag: Notification

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: GetNotificationSettingsOutput

Response fields

| Field | Type | Required | Description | Notes |

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

| notifications | array | No | | |

| receiveNotifications | boolean | No | | |

Example response

`json

{

"result": {

"receiveNotifications": false,

"notifications": [

{

"name": "string",

"displayName": "string",

"description": "string"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Notification/GetNotificationSettings"

$tenantId = 12345

$accessToken = ""

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

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

`

GetNotificationsPublishedByUser

Method: GET

Path: /api/services/app/Notification/GetNotificationsPublishedByUser

Operation ID: ApiServicesAppNotificationGetnotificationspublishedbyuserGet

Tag: Notification

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: GetPublishedNotificationsOutput

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

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

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"notificationName": "string",

"data": "string",

"dataTypeName": "string"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Notification/GetNotificationsPublishedByUser?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 GET -Uri $uri -Headers $headers

`

GetUserNotifications

Method: GET

Path: /api/services/app/Notification/GetUserNotifications

Operation ID: ApiServicesAppNotificationGetusernotificationsGet

Tag: Notification

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 |

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

| State | query | enum(0 | 1) | No | | format: int32

enum: 0, 1 |

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

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

| 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: GetNotificationsOutput

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

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

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

Example response

`json

{

"result": {

"unreadCount": 0,

"totalCount": 0,

"items": [

{

"tenantId": 0,

"userId": 0,

"state": 0

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Notification/GetUserNotifications?State=0&StartDate=2025-01-01T00%3A00%3A00Z&EndDate=2025-01-01T00%3A00%3A00Z" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Notification/GetUserNotifications?State=0&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 GET -Uri $uri -Headers $headers

`

SetAllAvailableVersionNotificationAsRead

Method: POST

Path: /api/services/app/Notification/SetAllAvailableVersionNotificationAsRead

Operation ID: ApiServicesAppNotificationSetallavailableversionnotificationasreadPost

Tag: Notification

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: SetNotificationAsReadOutput

Response fields

| Field | Type | Required | Description | Notes |

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

| success | boolean | No | | |

Example response

`json

{

"result": {

"success": false

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

-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/Notification/SetAllAvailableVersionNotificationAsRead"

$tenantId = 12345

$accessToken = ""

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

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

`

SetAllNotificationsAsRead

Method: POST

Path: /api/services/app/Notification/SetAllNotificationsAsRead

Operation ID: ApiServicesAppNotificationSetallnotificationsasreadPost

Tag: Notification

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/Notification/SetAllNotificationsAsRead" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Notification/SetAllNotificationsAsRead"

$tenantId = 12345

$accessToken = ""

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

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

`

SetNotificationAsRead

Method: POST

Path: /api/services/app/Notification/SetNotificationAsRead

Operation ID: ApiServicesAppNotificationSetnotificationasreadPost

Tag: Notification

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: GuidEntityDto

Request body fields

| Field | Type | Required | Description | Notes |

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

| id | string (uuid) | No | | format: uuid |

Example request body

`json

{

"id": "00000000-0000-0000-0000-000000000000"

}

`

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: SetNotificationAsReadOutput

Response fields

| Field | Type | Required | Description | Notes |

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

| success | boolean | No | | |

Example response

`json

{

"result": {

"success": false

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"id":"00000000-0000-0000-0000-000000000000"}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Notification/SetNotificationAsRead"

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"id": "00000000-0000-0000-0000-000000000000"

}

'@

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

`

ShouldUserUpdateApp

Method: POST

Path: /api/services/app/Notification/ShouldUserUpdateApp

Operation ID: ApiServicesAppNotificationShoulduserupdateappPost

Tag: Notification

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: boolean

Response fields

None

Example response

`json

{

"result": false,

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

-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/Notification/ShouldUserUpdateApp"

$tenantId = 12345

$accessToken = ""

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

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

`

UpdateNotificationSettings

Method: PUT

Path: /api/services/app/Notification/UpdateNotificationSettings

Operation ID: ApiServicesAppNotificationUpdatenotificationsettingsPut

Tag: Notification

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: UpdateNotificationSettingsInput

Request body fields

| Field | Type | Required | Description | Notes |

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

| notifications | array | No | | |

| receiveNotifications | boolean | No | | |

Example request body

`json

{

"receiveNotifications": false,

"notifications": [

{

"name": "string",

"isSubscribed": false

}

]

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"receiveNotifications":false,"notifications":[{"name":"string","isSubscribed":false}]}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Notification/UpdateNotificationSettings"

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"receiveNotifications": false,

"notifications": [

{

"name": "string",

"isSubscribed": false

}

]

}

'@

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

`

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