Cloud API - Tenants and Organization Units

Updated

Cloud API - Tenants and Organization Units

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

This article documents tenancy and organization structure endpoints (tenants, registration, organization units, and related operations).

AddDashboardsToOrganizationUnit

Method: POST

Path: /api/services/app/OrganizationUnit/AddDashboardsToOrganizationUnit

Operation ID: ApiServicesAppOrganizationunitAdddashboardstoorganizationunitPost

Tag: OrganizationUnit

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

Request body fields

| Field | Type | Required | Description | Notes |

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

| dashboardIds | array | No | | |

| organizationUnitId | integer (int64) | No | | format: int64

min: 1 |

Example request body

`json

{

"dashboardIds": [

"00000000-0000-0000-0000-000000000000"

],

"organizationUnitId": 1

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"dashboardIds":["00000000-0000-0000-0000-000000000000"],"organizationUnitId":1}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/OrganizationUnit/AddDashboardsToOrganizationUnit"

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"dashboardIds": [

"00000000-0000-0000-0000-000000000000"

],

"organizationUnitId": 1

}

'@

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

`

AddRolesToOrganizationUnit

Method: POST

Path: /api/services/app/OrganizationUnit/AddRolesToOrganizationUnit

Operation ID: ApiServicesAppOrganizationunitAddrolestoorganizationunitPost

Tag: OrganizationUnit

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

Request body fields

| Field | Type | Required | Description | Notes |

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

| organizationUnitId | integer (int64) | No | | format: int64

min: 1 |

| roleIds | array | No | | |

Example request body

`json

{

"roleIds": [

0

],

"organizationUnitId": 1

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"roleIds":[0],"organizationUnitId":1}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/OrganizationUnit/AddRolesToOrganizationUnit"

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"roleIds": [

0

],

"organizationUnitId": 1

}

'@

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

`

AddUsersToOrganizationUnit

Method: POST

Path: /api/services/app/OrganizationUnit/AddUsersToOrganizationUnit

Operation ID: ApiServicesAppOrganizationunitAdduserstoorganizationunitPost

Tag: OrganizationUnit

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

Request body fields

| Field | Type | Required | Description | Notes |

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

| organizationUnitId | integer (int64) | No | | format: int64

min: 1 |

| userIds | array | No | | |

Example request body

`json

{

"userIds": [

0

],

"organizationUnitId": 1

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"userIds":[0],"organizationUnitId":1}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/OrganizationUnit/AddUsersToOrganizationUnit"

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"userIds": [

0

],

"organizationUnitId": 1

}

'@

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

`

CreateOrganizationUnit

Method: POST

Path: /api/services/app/OrganizationUnit/CreateOrganizationUnit

Operation ID: ApiServicesAppOrganizationunitCreateorganizationunitPost

Tag: OrganizationUnit

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

Request body fields

| Field | Type | Required | Description | Notes |

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

| displayName | string | Yes | | minLength: 0

maxLength: 128 |

Example request body

`json

{

"displayName": "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: OrganizationUnitDto

Response fields

| Field | Type | Required | Description | Notes |

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

| code | string | No | | |

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

| creatorUserId | integer (int64) | No | | format: int64 |

| displayName | string | No | | |

| id | integer (int64) | No | | format: int64 |

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

| lastModifierUserId | integer (int64) | No | | format: int64 |

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

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

Example response

`json

{

"result": {

"code": "string",

"displayName": "string",

"memberCount": 0

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

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

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/OrganizationUnit/CreateOrganizationUnit"

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"displayName": "string"

}

'@

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

`

DeleteOrganizationUnit

Method: DELETE

Path: /api/services/app/OrganizationUnit/DeleteOrganizationUnit

Operation ID: ApiServicesAppOrganizationunitDeleteorganizationunitDelete

Tag: OrganizationUnit

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

Request body

None

Response

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/OrganizationUnit/DeleteOrganizationUnit?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/OrganizationUnit/DeleteOrganizationUnit?Id=0"

$tenantId = 12345

$accessToken = ""

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

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

`

FindDashboards

Method: POST

Path: /api/services/app/OrganizationUnit/FindDashboards

Operation ID: ApiServicesAppOrganizationunitFinddashboardsPost

Tag: OrganizationUnit

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

Request body fields

| Field | Type | Required | Description | Notes |

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

| filter | string | No | | |

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

min: 1

max: 1000 |

| organizationUnitId | integer (int64) | No | | format: int64 |

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

min: 0

max: 2147483647 |

Example request body

`json

{

"organizationUnitId": 0,

"maxResultCount": 1,

"skipCount": 0

}

`

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/OrganizationUnit/FindDashboards" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"organizationUnitId":0,"maxResultCount":1,"skipCount":0}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/OrganizationUnit/FindDashboards"

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"organizationUnitId": 0,

"maxResultCount": 1,

"skipCount": 0

}

'@

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

`

FindRoles

Method: POST

Path: /api/services/app/OrganizationUnit/FindRoles

Operation ID: ApiServicesAppOrganizationunitFindrolesPost

Tag: OrganizationUnit

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

Request body fields

| Field | Type | Required | Description | Notes |

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

| filter | string | No | | |

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

min: 1

max: 1000 |

| organizationUnitId | integer (int64) | No | | format: int64 |

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

min: 0

max: 2147483647 |

Example request body

`json

{

"organizationUnitId": 0,

"maxResultCount": 1,

"skipCount": 0

}

`

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/OrganizationUnit/FindRoles" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"organizationUnitId":0,"maxResultCount":1,"skipCount":0}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/OrganizationUnit/FindRoles"

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"organizationUnitId": 0,

"maxResultCount": 1,

"skipCount": 0

}

'@

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

`

FindUsers

Method: POST

Path: /api/services/app/OrganizationUnit/FindUsers

Operation ID: ApiServicesAppOrganizationunitFindusersPost

Tag: OrganizationUnit

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

Request body fields

| Field | Type | Required | Description | Notes |

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

| filter | string | No | | |

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

min: 1

max: 1000 |

| organizationUnitId | integer (int64) | No | | format: int64 |

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

min: 0

max: 2147483647 |

Example request body

`json

{

"organizationUnitId": 0,

"maxResultCount": 1,

"skipCount": 0

}

`

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/OrganizationUnit/FindUsers" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"organizationUnitId":0,"maxResultCount":1,"skipCount":0}'

`

PowerShell

`powershell

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

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

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"organizationUnitId": 0,

"maxResultCount": 1,

"skipCount": 0

}

'@

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

`

GetAll

Method: GET

Path: /api/services/app/OrganizationUnit/GetAll

Operation ID: ApiServicesAppOrganizationunitGetallGet

Tag: OrganizationUnit

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

{

"code": "string",

"displayName": "string",

"memberCount": 0

}

],

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/OrganizationUnit/GetAll"

$tenantId = 12345

$accessToken = ""

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

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

`

GetDashboardsNotInOrganizationUnit

Method: GET

Path: /api/services/app/OrganizationUnit/GetDashboardsNotInOrganizationUnit

Operation ID: ApiServicesAppOrganizationunitGetdashboardsnotinorganizationunitGet

Tag: OrganizationUnit

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

| 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: 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 GET "https://public-api.loadgen.cloud/api/services/app/OrganizationUnit/GetDashboardsNotInOrganizationUnit?Filter=string&Sorting=string&MaxResultCount=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/OrganizationUnit/GetDashboardsNotInOrganizationUnit?Filter=string&Sorting=string&MaxResultCount=1"

$tenantId = 12345

$accessToken = ""

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

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

`

GetObjectsInOrganizationUnit

Method: GET

Path: /api/services/app/OrganizationUnit/GetObjectsInOrganizationUnit

Operation ID: ApiServicesAppOrganizationunitGetobjectsinorganizationunitGet

Tag: OrganizationUnit

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 |

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

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

| ObjectType | query | enum(0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15) | No | | format: int32

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

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

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": "00000000-0000-0000-0000-000000000000",

"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/OrganizationUnit/GetObjectsInOrganizationUnit?OrganizationUnitId=0&ObjectType=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/OrganizationUnit/GetObjectsInOrganizationUnit?OrganizationUnitId=0&ObjectType=0&Sorting=string"

$tenantId = 12345

$accessToken = ""

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

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

`

GetObjectsNotInOrganizationUnit

Method: GET

Path: /api/services/app/OrganizationUnit/GetObjectsNotInOrganizationUnit

Operation ID: ApiServicesAppOrganizationunitGetobjectsnotinorganizationunitGet

Tag: OrganizationUnit

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 |

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

| ObjectType | query | enum(0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15) | No | | format: int32

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

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

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": "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/OrganizationUnit/GetObjectsNotInOrganizationUnit?ObjectType=0&Sorting=string&MaxResultCount=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/OrganizationUnit/GetObjectsNotInOrganizationUnit?ObjectType=0&Sorting=string&MaxResultCount=1"

$tenantId = 12345

$accessToken = ""

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

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

`

GetOrganizationUnitDashboards

Method: GET

Path: /api/services/app/OrganizationUnit/GetOrganizationUnitDashboards

Operation ID: ApiServicesAppOrganizationunitGetorganizationunitdashboardsGet

Tag: OrganizationUnit

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

min: 1 |

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

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",

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

"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/OrganizationUnit/GetOrganizationUnitDashboards?Id=1&Sorting=string&MaxResultCount=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/OrganizationUnit/GetOrganizationUnitDashboards?Id=1&Sorting=string&MaxResultCount=1"

$tenantId = 12345

$accessToken = ""

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

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

`

GetOrganizationUnitRoles

Method: GET

Path: /api/services/app/OrganizationUnit/GetOrganizationUnitRoles

Operation ID: ApiServicesAppOrganizationunitGetorganizationunitrolesGet

Tag: OrganizationUnit

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

min: 1 |

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

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

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

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"displayName": "string",

"name": "string",

"addedTime": "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/OrganizationUnit/GetOrganizationUnitRoles?Id=1&Sorting=string&MaxResultCount=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/OrganizationUnit/GetOrganizationUnitRoles?Id=1&Sorting=string&MaxResultCount=1"

$tenantId = 12345

$accessToken = ""

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

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

`

GetOrganizationUnits

Method: GET

Path: /api/services/app/OrganizationUnit/GetOrganizationUnits

Operation ID: ApiServicesAppOrganizationunitGetorganizationunitsGet

Tag: OrganizationUnit

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

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

Example response

`json

{

"result": {

"items": [

{

"code": "string",

"displayName": "string",

"memberCount": 0

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/OrganizationUnit/GetOrganizationUnits"

$tenantId = 12345

$accessToken = ""

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

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

`

GetOrganizationUnitsWithChildren

Method: GET

Path: /api/services/app/OrganizationUnit/GetOrganizationUnitsWithChildren

Operation ID: ApiServicesAppOrganizationunitGetorganizationunitswithchildrenGet

Tag: OrganizationUnit

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

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

Example response

`json

{

"result": {

"items": [

{

"code": "string",

"displayName": "string",

"items": {

"None": [],

"Dashboards": [],

"CloudAgents": []

}

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/OrganizationUnit/GetOrganizationUnitsWithChildren"

$tenantId = 12345

$accessToken = ""

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

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

`

GetOrganizationUnitUsers

Method: GET

Path: /api/services/app/OrganizationUnit/GetOrganizationUnitUsers

Operation ID: ApiServicesAppOrganizationunitGetorganizationunitusersGet

Tag: OrganizationUnit

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

min: 1 |

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

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",

"surname": "string",

"userName": "string"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/OrganizationUnit/GetOrganizationUnitUsers?Id=1&Sorting=string&MaxResultCount=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/OrganizationUnit/GetOrganizationUnitUsers?Id=1&Sorting=string&MaxResultCount=1"

$tenantId = 12345

$accessToken = ""

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

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

`

RemoveDashboardFromOrganizationUnit

Method: DELETE

Path: /api/services/app/OrganizationUnit/RemoveDashboardFromOrganizationUnit

Operation ID: ApiServicesAppOrganizationunitRemovedashboardfromorganizationunitDelete

Tag: OrganizationUnit

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 |

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

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

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

min: 1 |

Request body

None

Response

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/OrganizationUnit/RemoveDashboardFromOrganizationUnit?DashboardId=00000000-0000-0000-0000-000000000000&OrganizationUnitId=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/OrganizationUnit/RemoveDashboardFromOrganizationUnit?DashboardId=00000000-0000-0000-0000-000000000000&OrganizationUnitId=1"

$tenantId = 12345

$accessToken = ""

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

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

`

RemoveOrganizationUnitForObject

Method: DELETE

Path: /api/services/app/OrganizationUnit/RemoveOrganizationUnitForObject

Operation ID: ApiServicesAppOrganizationunitRemoveorganizationunitforobjectDelete

Tag: OrganizationUnit

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 |

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

| ObjectType | query | enum(0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15) | No | | format: int32

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

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

| 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/OrganizationUnit/RemoveOrganizationUnitForObject?ObjectType=0&OrganizationUnitId=0&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/OrganizationUnit/RemoveOrganizationUnitForObject?ObjectType=0&OrganizationUnitId=0&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

`

RemoveRoleFromOrganizationUnit

Method: DELETE

Path: /api/services/app/OrganizationUnit/RemoveRoleFromOrganizationUnit

Operation ID: ApiServicesAppOrganizationunitRemoverolefromorganizationunitDelete

Tag: OrganizationUnit

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 |

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

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

min: 1 |

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

min: 1 |

Request body

None

Response

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/OrganizationUnit/RemoveRoleFromOrganizationUnit?RoleId=1&OrganizationUnitId=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/OrganizationUnit/RemoveRoleFromOrganizationUnit?RoleId=1&OrganizationUnitId=1"

$tenantId = 12345

$accessToken = ""

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

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

`

RemoveUserFromOrganizationUnit

Method: DELETE

Path: /api/services/app/OrganizationUnit/RemoveUserFromOrganizationUnit

Operation ID: ApiServicesAppOrganizationunitRemoveuserfromorganizationunitDelete

Tag: OrganizationUnit

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 |

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

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

min: 1 |

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

min: 1 |

Request body

None

Response

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/OrganizationUnit/RemoveUserFromOrganizationUnit?UserId=1&OrganizationUnitId=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/OrganizationUnit/RemoveUserFromOrganizationUnit?UserId=1&OrganizationUnitId=1"

$tenantId = 12345

$accessToken = ""

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

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

`

SetOrganizationUnitForObject

Method: POST

Path: /api/services/app/OrganizationUnit/SetOrganizationUnitForObject

Operation ID: ApiServicesAppOrganizationunitSetorganizationunitforobjectPost

Tag: OrganizationUnit

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

Request body fields

| Field | Type | Required | Description | Notes |

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

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

| move | object(MoveObjectOrganizationUnitInput) | No | | |

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

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

| organizationUnitId | integer (int64) | No | | format: int64 |

Example request body

`json

{

"objectType": 0,

"organizationUnitId": 0,

"move": {

"oldOrganizationUnit": 0

}

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"objectType":0,"organizationUnitId":0,"move":{"oldOrganizationUnit":0}}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/OrganizationUnit/SetOrganizationUnitForObject"

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"objectType": 0,

"organizationUnitId": 0,

"move": {

"oldOrganizationUnit": 0

}

}

'@

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

`

UpdateOrganizationUnit

Method: PUT

Path: /api/services/app/OrganizationUnit/UpdateOrganizationUnit

Operation ID: ApiServicesAppOrganizationunitUpdateorganizationunitPut

Tag: OrganizationUnit

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

Request body fields

| Field | Type | Required | Description | Notes |

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

| displayName | string | Yes | | minLength: 0

maxLength: 128 |

| id | integer (int64) | No | | format: int64

min: 1 |

Example request body

`json

{

"displayName": "string",

"id": 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: OrganizationUnitDto

Response fields

| Field | Type | Required | Description | Notes |

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

| code | string | No | | |

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

| creatorUserId | integer (int64) | No | | format: int64 |

| displayName | string | No | | |

| id | integer (int64) | No | | format: int64 |

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

| lastModifierUserId | integer (int64) | No | | format: int64 |

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

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

Example response

`json

{

"result": {

"code": "string",

"displayName": "string",

"memberCount": 0

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"displayName":"string","id":1}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/OrganizationUnit/UpdateOrganizationUnit"

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"displayName": "string",

"id": 1

}

'@

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

`

CreateTenant

Method: POST

Path: /api/services/app/Tenant/CreateTenant

Operation ID: ApiServicesAppTenantCreatetenantPost

Tag: Tenant

Authentication: Yes (Bearer token)

Scope: Host (tenant administration)

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

Request body fields

| Field | Type | Required | Description | Notes |

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

| name | string | Yes | | minLength: 0

maxLength: 128 |

| superUserEmailAddress | string (email) | Yes | | format: email

minLength: 0

maxLength: 256 |

| tenancyName | string | Yes | | minLength: 0

maxLength: 64

pattern: ^[a-zA-Z][a-zA-Z0-9_-]{1,}$ |

| userFirstName | string | Yes | | minLength: 0

maxLength: 64 |

| userSurname | string | Yes | | minLength: 0

maxLength: 64 |

| adminName | string | No | | minLength: 0

maxLength: 64 |

| adminSurname | string | No | | minLength: 0

maxLength: 64 |

| connectionString | string | No | | maxLength: 1024 |

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

| isActive | boolean | No | | |

| isInTrialPeriod | boolean | No | | |

| sendActivationEmail | boolean | No | | |

| shouldChangePasswordOnNextLogin | boolean | No | | |

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

| superUserPassword | string | No | | minLength: 0

maxLength: 128 |

Example request body

`json

{

"name": "string",

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

"tenancyName": "string",

"userFirstName": "string",

"userSurname": "string"

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Accept: application/json" \\

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

--data-raw '{"name":"string","superUserEmailAddress":"user@example.com","tenancyName":"string","userFirstName":"string","userSurname":"string"}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Tenant/CreateTenant"

$accessToken = ""

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

$body = @'

{

"name": "string",

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

"tenancyName": "string",

"userFirstName": "string",

"userSurname": "string"

}

'@

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

`

DeleteMultipleTenants

Method: DELETE

Path: /api/services/app/Tenant/DeleteMultipleTenants

Operation ID: ApiServicesAppTenantDeletemultipletenantsDelete

Tag: Tenant

Authentication: Yes (Bearer token)

Scope: Host (tenant administration)

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

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

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

| inputs | query | array | No | | |

Request body

None

Response

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/Tenant/DeleteMultipleTenants?inputs=%5Bobject%20Object%5D" \\

-H "Authorization: Bearer " \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Tenant/DeleteMultipleTenants?inputs=%5Bobject%20Object%5D"

$accessToken = ""

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

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

`

DeleteTenant

Method: DELETE

Path: /api/services/app/Tenant/DeleteTenant

Operation ID: ApiServicesAppTenantDeletetenantDelete

Tag: Tenant

Authentication: Yes (Bearer token)

Scope: Host (tenant administration)

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

| 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/Tenant/DeleteTenant?Id=0" \\

-H "Authorization: Bearer " \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Tenant/DeleteTenant?Id=0"

$accessToken = ""

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

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

`

GetTenantFeaturesForEdit

Method: GET

Path: /api/services/app/Tenant/GetTenantFeaturesForEdit

Operation ID: ApiServicesAppTenantGettenantfeaturesforeditGet

Tag: Tenant

Authentication: Yes (Bearer token)

Scope: Host (tenant administration)

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

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

Response fields

| Field | Type | Required | Description | Notes |

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

| features | array | No | | |

| featureValues | array | No | | |

Example response

`json

{

"result": {

"featureValues": [

{

"name": "string",

"value": "string"

}

],

"features": [

{

"parentName": "string",

"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/Tenant/GetTenantFeaturesForEdit?Id=0" \\

-H "Authorization: Bearer " \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Tenant/GetTenantFeaturesForEdit?Id=0"

$accessToken = ""

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

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

`

GetTenantForEdit

Method: GET

Path: /api/services/app/Tenant/GetTenantForEdit

Operation ID: ApiServicesAppTenantGettenantforeditGet

Tag: Tenant

Authentication: Yes (Bearer token)

Scope: Host (tenant administration)

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

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

Response fields

| Field | Type | Required | Description | Notes |

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

| name | string | Yes | | minLength: 0

maxLength: 128 |

| tenancyName | string | Yes | | minLength: 0

maxLength: 64 |

| connectionString | string | No | | |

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

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

| isActive | boolean | No | | |

| isInTrialPeriod | boolean | No | | |

| stripeEnabled | boolean | No | | |

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

| timezoneCode | string | No | | |

Example response

`json

{

"result": {

"name": "string",

"tenancyName": "string",

"connectionString": "string"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Tenant/GetTenantForEdit?Id=0"

$accessToken = ""

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

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

`

GetTenants

Method: GET

Path: /api/services/app/Tenant/GetTenants

Operation ID: ApiServicesAppTenantGettenantsGet

Tag: Tenant

Authentication: Yes (Bearer token)

Scope: Host (tenant administration)

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

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

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

| Filter | query | string | No | | |

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

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

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

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

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

| EditionIdSpecified | query | boolean | No | | |

| FeatureName | 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: TenantListDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

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

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"tenancyName": "string",

"name": "string",

"editionDisplayName": "string"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Tenant/GetTenants?Filter=string&SubscriptionEndDateStart=2025-01-01T00%3A00%3A00Z&SubscriptionEndDateEnd=2025-01-01T00%3A00%3A00Z" \\

-H "Authorization: Bearer " \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Tenant/GetTenants?Filter=string&SubscriptionEndDateStart=2025-01-01T00%3A00%3A00Z&SubscriptionEndDateEnd=2025-01-01T00%3A00%3A00Z"

$accessToken = ""

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

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

`

ResetTenantSpecificFeatures

Method: POST

Path: /api/services/app/Tenant/ResetTenantSpecificFeatures

Operation ID: ApiServicesAppTenantResettenantspecificfeaturesPost

Tag: Tenant

Authentication: Yes (Bearer token)

Scope: Host (tenant administration)

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

Request body fields

| Field | Type | Required | Description | Notes |

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

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

Example request body

`json

{

"id": 0

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Accept: application/json" \\

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

--data-raw '{"id":0}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Tenant/ResetTenantSpecificFeatures"

$accessToken = ""

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

$body = @'

{

"id": 0

}

'@

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

`

UnlockTenantAdmin

Method: POST

Path: /api/services/app/Tenant/UnlockTenantAdmin

Operation ID: ApiServicesAppTenantUnlocktenantadminPost

Tag: Tenant

Authentication: Yes (Bearer token)

Scope: Host (tenant administration)

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

Request body fields

| Field | Type | Required | Description | Notes |

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

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

Example request body

`json

{

"id": 0

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Accept: application/json" \\

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

--data-raw '{"id":0}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Tenant/UnlockTenantAdmin"

$accessToken = ""

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

$body = @'

{

"id": 0

}

'@

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

`

UnlockTenantUser

Method: POST

Path: /api/services/app/Tenant/UnlockTenantUser

Operation ID: ApiServicesAppTenantUnlocktenantuserPost

Tag: Tenant

Authentication: Yes (Bearer token)

Scope: Host (tenant administration)

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

Request body fields

| Field | Type | Required | Description | Notes |

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

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

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

Example request body

`json

{

"userId": 0,

"id": 0

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Accept: application/json" \\

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

--data-raw '{"userId":0,"id":0}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Tenant/UnlockTenantUser"

$accessToken = ""

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

$body = @'

{

"userId": 0,

"id": 0

}

'@

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

`

UpdateTenant

Method: PUT

Path: /api/services/app/Tenant/UpdateTenant

Operation ID: ApiServicesAppTenantUpdatetenantPut

Tag: Tenant

Authentication: Yes (Bearer token)

Scope: Host (tenant administration)

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

Request body fields

| Field | Type | Required | Description | Notes |

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

| name | string | Yes | | minLength: 0

maxLength: 128 |

| tenancyName | string | Yes | | minLength: 0

maxLength: 64 |

| connectionString | string | No | | |

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

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

| isActive | boolean | No | | |

| isInTrialPeriod | boolean | No | | |

| stripeEnabled | boolean | No | | |

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

| timezoneCode | string | No | | |

Example request body

`json

{

"name": "string",

"tenancyName": "string",

"connectionString": "string"

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Accept: application/json" \\

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

--data-raw '{"name":"string","tenancyName":"string","connectionString":"string"}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Tenant/UpdateTenant"

$accessToken = ""

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

$body = @'

{

"name": "string",

"tenancyName": "string",

"connectionString": "string"

}

'@

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

`

UpdateTenantFeatures

Method: PUT

Path: /api/services/app/Tenant/UpdateTenantFeatures

Operation ID: ApiServicesAppTenantUpdatetenantfeaturesPut

Tag: Tenant

Authentication: Yes (Bearer token)

Scope: Host (tenant administration)

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

Request body fields

| Field | Type | Required | Description | Notes |

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

| featureValues | array | Yes | | |

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

min: 1

max: 2147483647 |

Example request body

`json

{

"featureValues": [

{

"name": "string",

"value": "string"

}

],

"id": 1

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Accept: application/json" \\

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

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

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Tenant/UpdateTenantFeatures"

$accessToken = ""

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

$body = @'

{

"featureValues": [

{

"name": "string",

"value": "string"

}

],

"id": 1

}

'@

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

`

GetTenantLogo

Method: GET

Path: /TenantCustomization/GetTenantLogo/{skin}/{tenantId}/{extension}

Operation ID: TenantcustomizationGettenantlogoBySkinByTenantidByExtensionGet

Tag: TenantCustomization

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • 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 |

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

| skin | path | string | Yes | | |

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

| extension | query | string | No | svg | |

Request body

None

Response

None

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/TenantCustomization/GetTenantLogo/string/{tenantId}/{extension}?tenantId=0&extension=string" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/TenantCustomization/GetTenantLogo/string/{tenantId}/{extension}?tenantId=0&extension=string"

$tenantId = 12345

$accessToken = ""

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

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

`

GetEdition

Method: GET

Path: /api/services/app/TenantRegistration/GetEdition

Operation ID: ApiServicesAppTenantregistrationGeteditionGet

Tag: TenantRegistration

Authentication: No (public endpoint)

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 |

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

| editionId | 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: EditionSelectDto

Response fields

| Field | Type | Required | Description | Notes |

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

| annualPrice | number (double) | No | | format: double |

| dailyPrice | number (double) | No | | format: double |

| displayName | string | No | | |

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

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

| isFree | boolean | No | | |

| monthlyPrice | number (double) | No | | format: double |

| name | string | No | | |

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

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

| weeklyPrice | number (double) | No | | format: double |

Example response

`json

{

"result": {

"id": 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/TenantRegistration/GetEdition?editionId=0" \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/TenantRegistration/GetEdition?editionId=0"

$tenantId = 12345

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

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

`

GetEditionsForSelect

Method: GET

Path: /api/services/app/TenantRegistration/GetEditionsForSelect

Operation ID: ApiServicesAppTenantregistrationGeteditionsforselectGet

Tag: TenantRegistration

Authentication: No (public endpoint)

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

Response fields

| Field | Type | Required | Description | Notes |

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

| allFeatures | array | No | | |

| editionsWithFeatures | array | No | | |

Example response

`json

{

"result": {

"allFeatures": [

{

"parentName": "string",

"name": "string",

"displayName": "string"

}

],

"editionsWithFeatures": [

{

"edition": {

"id": 0,

"name": "string",

"displayName": "string"

},

"featureValues": [

{}

]

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/TenantRegistration/GetEditionsForSelect"

$tenantId = 12345

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

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

`

RegisterTenant

Method: POST

Path: /api/services/app/TenantRegistration/RegisterTenant

Operation ID: ApiServicesAppTenantregistrationRegistertenantPost

Tag: TenantRegistration

Authentication: No (public endpoint)

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

Request body fields

| Field | Type | Required | Description | Notes |

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

| adminEmailAddress | string (email) | Yes | | format: email

minLength: 0

maxLength: 256 |

| name | string | Yes | | minLength: 0

maxLength: 64 |

| tenancyName | string | Yes | | minLength: 0

maxLength: 64 |

| adminName | string | No | | minLength: 0

maxLength: 64 |

| adminPassword | string | No | | minLength: 0

maxLength: 32 |

| adminSurname | string | No | | minLength: 0

maxLength: 64 |

| captchaResponse | string | No | | |

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

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

enum: 1, 2, 3 |

Example request body

`json

{

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

"name": "string",

"tenancyName": "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: RegisterTenantOutput

Response fields

| Field | Type | Required | Description | Notes |

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

| emailAddress | string | No | | |

| isActive | boolean | No | | |

| isEmailConfirmationRequired | boolean | No | | |

| isTenantActive | boolean | No | | |

| name | string | No | | |

| tenancyName | string | No | | |

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

| userName | string | No | | |

Example response

`json

{

"result": {

"tenantId": 0,

"tenancyName": "string",

"name": "string"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"adminEmailAddress":"user@example.com","name":"string","tenancyName":"string"}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/TenantRegistration/RegisterTenant"

$tenantId = 12345

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

$body = @'

{

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

"name": "string",

"tenancyName": "string"

}

'@

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

`

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