Cloud API - Marketplace

Cloud API - Marketplace

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

This article documents marketplace endpoints (categories, items, versions, download/import, and approvals).

ApproveWorkloadItem

Method: POST

Path: /api/services/app/Marketplace/ApproveWorkloadItem

Operation ID: ApiServicesAppMarketplaceApproveworkloaditemPost

Tag: Marketplace

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 POST "https://public-api.loadgen.cloud/api/services/app/Marketplace/ApproveWorkloadItem?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/Marketplace/ApproveWorkloadItem?id=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

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

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

`

CreateNewMarketplaceWorkloadVersion

Method: POST

Path: /api/services/app/Marketplace/CreateNewMarketplaceWorkloadVersion

Operation ID: ApiServicesAppMarketplaceCreatenewmarketplaceworkloadversionPost

Tag: Marketplace

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

Request body fields

| Field | Type | Required | Description | Notes |

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

| description | string | No | | |

| isCitrixEnhanced | boolean | No | | |

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

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

| releaseNotes | string | No | | |

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

| workloadBytes | string (byte) | No | | format: byte |

| workloadUrl | string | No | | |

Example request body

`json

{

"marketPlaceItemId": "00000000-0000-0000-0000-000000000000",

"version": 0,

"isCitrixEnhanced": false

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"marketPlaceItemId":"00000000-0000-0000-0000-000000000000","version":0,"isCitrixEnhanced":false}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Marketplace/CreateNewMarketplaceWorkloadVersion"

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"marketPlaceItemId": "00000000-0000-0000-0000-000000000000",

"version": 0,

"isCitrixEnhanced": false

}

'@

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

`

CreateOrUpdateCategory

Method: POST

Path: /api/services/app/Marketplace/CreateOrUpdateCategory

Operation ID: ApiServicesAppMarketplaceCreateorupdatecategoryPost

Tag: Marketplace

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

Request body fields

| Field | Type | Required | Description | Notes |

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

| approved | boolean | No | | |

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

| isWebTesting | boolean | No | | |

| name | string | No | | |

Example request body

`json

{

"name": "string",

"approved": false,

"isWebTesting": false

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '{"name":"string","approved":false,"isWebTesting":false}'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Marketplace/CreateOrUpdateCategory"

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"name": "string",

"approved": false,

"isWebTesting": false

}

'@

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

`

DeleteCategory

Method: DELETE

Path: /api/services/app/Marketplace/DeleteCategory

Operation ID: ApiServicesAppMarketplaceDeletecategoryDelete

Tag: Marketplace

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/Marketplace/DeleteCategory?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/Marketplace/DeleteCategory?Id=0"

$tenantId = 12345

$accessToken = ""

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

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

`

DeleteEntireMarketplaceItem

Method: DELETE

Path: /api/services/app/Marketplace/DeleteEntireMarketplaceItem

Operation ID: ApiServicesAppMarketplaceDeleteentiremarketplaceitemDelete

Tag: Marketplace

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/Marketplace/DeleteEntireMarketplaceItem?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/Marketplace/DeleteEntireMarketplaceItem?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

`

DeleteMarketplaceItem

Method: DELETE

Path: /api/services/app/Marketplace/DeleteMarketplaceItem

Operation ID: ApiServicesAppMarketplaceDeletemarketplaceitemDelete

Tag: Marketplace

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/Marketplace/DeleteMarketplaceItem?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/Marketplace/DeleteMarketplaceItem?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

`

DownloadMarketPlaceWorkloadItem

Method: POST

Path: /api/services/app/Marketplace/DownloadMarketPlaceWorkloadItem

Operation ID: ApiServicesAppMarketplaceDownloadmarketplaceworkloaditemPost

Tag: Marketplace

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

Response fields

| Field | Type | Required | Description | Notes |

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

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

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

| fileType | string | No | | |

Example response

`json

{

"result": {

"fileName": "string",

"fileToken": "string",

"fileType": "string"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Marketplace/DownloadMarketPlaceWorkloadItem?id=00000000-0000-0000-0000-000000000000" \\

-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/Marketplace/DownloadMarketPlaceWorkloadItem?id=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

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

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

`

GenerateCategories

Method: POST

Path: /api/services/app/Marketplace/GenerateCategories

Operation ID: ApiServicesAppMarketplaceGeneratecategoriesPost

Tag: Marketplace

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

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

Parameters

None

Request body

Request body schema: array

Request body fields

None

Example request body

`json

[

"string"

]

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '["string"]'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Marketplace/GenerateCategories"

$tenantId = 12345

$accessToken = ""

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

$body = @'

[

"string"

]

'@

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

`

GenerateCategoryNames

Method: POST

Path: /api/services/app/Marketplace/GenerateCategoryNames

Operation ID: ApiServicesAppMarketplaceGeneratecategorynamesPost

Tag: Marketplace

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

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

Example response

`json

{

"result": {

"items": [

{

"name": "string",

"isWebTesting": false,

"count": 0

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

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

-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/Marketplace/GenerateCategoryNames"

$tenantId = 12345

$accessToken = ""

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

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

`

GetAllCategories

Method: GET

Path: /api/services/app/Marketplace/GetAllCategories

Operation ID: ApiServicesAppMarketplaceGetallcategoriesGet

Tag: Marketplace

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

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

"isApproved": false,

"isWebTesting": false

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Marketplace/GetAllCategories?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/Marketplace/GetAllCategories?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

`

GetAllCategoriesProgram

Method: GET

Path: /api/services/app/Marketplace/GetAllCategoriesProgram

Operation ID: ApiServicesAppMarketplaceGetallcategoriesprogramGet

Tag: Marketplace

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

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

"isApproved": false,

"isWebTesting": false

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Marketplace/GetAllCategoriesProgram?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/Marketplace/GetAllCategoriesProgram?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

`

GetAllMarketplaceItems

Method: GET

Path: /api/services/app/Marketplace/GetAllMarketplaceItems

Operation ID: ApiServicesAppMarketplaceGetallmarketplaceitemsGet

Tag: Marketplace

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

| ItemType | query | enum(0 | 1 | 2) | No | | format: int32

enum: 0, 1, 2 |

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

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

| ContributorType | query | enum(0 | 1 | 2 | 3 | 4) | No | | format: int32

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

| OSLanguage | query | string | No | | |

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

| isPublic | query | boolean | No | | |

| isWebTesting | query | boolean | 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: GetAllMarketplaceItemDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

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

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"title": "string",

"description": "string",

"company": "string"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Marketplace/GetAllMarketplaceItems?Filter=string&ItemType=0&UserId=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/Marketplace/GetAllMarketplaceItems?Filter=string&ItemType=0&UserId=0"

$tenantId = 12345

$accessToken = ""

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

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

`

GetAllMarketPlaceItemsAdmin

Method: GET

Path: /api/services/app/Marketplace/GetAllMarketPlaceItemsAdmin

Operation ID: ApiServicesAppMarketplaceGetallmarketplaceitemsadminGet

Tag: Marketplace

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 |

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

| HasBeenApproved | query | boolean | No | | |

| HasBeenReviewed | query | boolean | No | | |

| Filter | query | string | No | | |

| ItemType | query | enum(0 | 1 | 2) | No | | format: int32

enum: 0, 1, 2 |

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

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

| ContributorType | query | enum(0 | 1 | 2 | 3 | 4) | No | | format: int32

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

| OSLanguage | query | string | No | | |

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

| isPublic | query | boolean | No | | |

| isWebTesting | query | boolean | 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: GetAllMarketplaceItemAdminDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

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

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"hasBeenApproved": false,

"hasBeenReviewed": false,

"isLatestReviewed": false

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Marketplace/GetAllMarketPlaceItemsAdmin?HasBeenApproved=false&HasBeenReviewed=false&Filter=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/Marketplace/GetAllMarketPlaceItemsAdmin?HasBeenApproved=false&HasBeenReviewed=false&Filter=string"

$tenantId = 12345

$accessToken = ""

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

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

`

GetAllMarketplaceItemsForUser

Method: GET

Path: /api/services/app/Marketplace/GetAllMarketplaceItemsForUser

Operation ID: ApiServicesAppMarketplaceGetallmarketplaceitemsforuserGet

Tag: Marketplace

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

| ItemType | query | enum(0 | 1 | 2) | No | | format: int32

enum: 0, 1, 2 |

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

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

| ContributorType | query | enum(0 | 1 | 2 | 3 | 4) | No | | format: int32

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

| OSLanguage | query | string | No | | |

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

| isPublic | query | boolean | No | | |

| isWebTesting | query | boolean | 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: GetAllMarketplaceItemAdminDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

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

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"hasBeenApproved": false,

"hasBeenReviewed": false,

"isLatestReviewed": false

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Marketplace/GetAllMarketplaceItemsForUser?Filter=string&ItemType=0&UserId=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/Marketplace/GetAllMarketplaceItemsForUser?Filter=string&ItemType=0&UserId=0"

$tenantId = 12345

$accessToken = ""

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

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

`

GetMarketplaceItemCategories

Method: GET

Path: /api/services/app/Marketplace/GetMarketplaceItemCategories

Operation ID: ApiServicesAppMarketplaceGetmarketplaceitemcategoriesGet

Tag: Marketplace

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

Response fields

| Field | Type | Required | Description | Notes |

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

| items | array | No | | |

| marketPlaceItemName | string | No | | |

Example response

`json

{

"result": {

"items": [

{

"name": "string",

"isApproved": false,

"isWebTesting": false

}

],

"marketPlaceItemName": "string"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Marketplace/GetMarketplaceItemCategories?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/Marketplace/GetMarketplaceItemCategories?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

`

GetMarketplaceItemForEdit

Method: GET

Path: /api/services/app/Marketplace/GetMarketplaceItemForEdit

Operation ID: ApiServicesAppMarketplaceGetmarketplaceitemforeditGet

Tag: Marketplace

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

Response fields

| Field | Type | Required | Description | Notes |

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

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

| categories | array | No | | |

| companyName | string | No | | |

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

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

| description | string | No | | |

| emailAddress | string | No | | |

| firstName | string | No | | |

| hasBeenApproved | boolean | No | | |

| hasBeenReviewed | boolean | No | | |

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

| image | string (byte) | No | | format: byte |

| isPublic | boolean | No | | |

| isWebTesting | boolean | No | | |

| lastName | string | No | | |

| originalCategories | string | No | | |

| osLanguage | string | No | | |

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

| title | string | No | | |

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

enum: 0, 1, 2 |

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

| websiteUrl | string | No | | |

Example response

`json

{

"result": {

"title": "string",

"description": "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/Marketplace/GetMarketplaceItemForEdit?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/Marketplace/GetMarketplaceItemForEdit?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

`

GetMarketplaceWorkloadItem

Method: GET

Path: /api/services/app/Marketplace/GetMarketplaceWorkloadItem

Operation ID: ApiServicesAppMarketplaceGetmarketplaceworkloaditemGet

Tag: Marketplace

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: string (byte)

Response fields

None

Example response

`json

{

"result": "AA==",

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Marketplace/GetMarketplaceWorkloadItem?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/Marketplace/GetMarketplaceWorkloadItem?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

`

GetUserInfo

Method: GET

Path: /api/services/app/Marketplace/GetUserInfo

Operation ID: ApiServicesAppMarketplaceGetuserinfoGet

Tag: Marketplace

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

Response fields

| Field | Type | Required | Description | Notes |

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

| companyName | string | No | | |

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

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

| emailAddress | string | No | | |

| firstName | string | No | | |

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

| lastName | string | No | | |

Example response

`json

{

"result": {

"firstName": "string",

"lastName": "string",

"emailAddress": "user@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/Marketplace/GetUserInfo" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Marketplace/GetUserInfo"

$tenantId = 12345

$accessToken = ""

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

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

`

ImportMarketplaceWorkloadItem

Method: POST

Path: /api/services/app/Marketplace/ImportMarketplaceWorkloadItem

Operation ID: ApiServicesAppMarketplaceImportmarketplaceworkloaditemPost

Tag: Marketplace

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 |

| version | 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: 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/Marketplace/ImportMarketplaceWorkloadItem?Id=00000000-0000-0000-0000-000000000000&version=0" \\

-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/Marketplace/ImportMarketplaceWorkloadItem?Id=00000000-0000-0000-0000-000000000000&version=0"

$tenantId = 12345

$accessToken = ""

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

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

`

SetMarketplaceItemCategory

Method: POST

Path: /api/services/app/Marketplace/SetMarketplaceItemCategory

Operation ID: ApiServicesAppMarketplaceSetmarketplaceitemcategoryPost

Tag: Marketplace

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

Request body schema: array

Request body fields

None

Example request body

`json

[

0

]

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Marketplace/SetMarketplaceItemCategory?id=00000000-0000-0000-0000-000000000000" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

--data-raw '[0]'

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Marketplace/SetMarketplaceItemCategory?id=00000000-0000-0000-0000-000000000000"

$tenantId = 12345

$accessToken = ""

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

$body = @'

[

0

]

'@

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

`

UpdateMarketplaceItem

Method: PUT

Path: /api/services/app/Marketplace/UpdateMarketplaceItem

Operation ID: ApiServicesAppMarketplaceUpdatemarketplaceitemPut

Tag: Marketplace

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

Request body fields

| Field | Type | Required | Description | Notes |

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

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

| categories | array | No | | |

| companyName | string | No | | |

| description | string | No | | |

| emailAddress | string | No | | |

| firstName | string | No | | |

| hasBeenApproved | boolean | No | | |

| hasBeenReviewed | boolean | No | | |

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

| isPublic | boolean | No | | |

| isWebTesting | boolean | No | | |

| lastName | string | No | | |

| originalCategories | string | No | | |

| osLanguage | string | No | | |

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

| title | string | No | | |

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

enum: 0, 1, 2 |

| websiteUrl | string | No | | |

Example request body

`json

{

"title": "string",

"description": "string",

"type": 0

}

`

Response

None

Curl

`bash

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

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

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

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

`

PowerShell

`powershell

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

$uri = "$baseUrl/api/services/app/Marketplace/UpdateMarketplaceItem"

$tenantId = 12345

$accessToken = ""

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

$body = @'

{

"title": "string",

"description": "string",

"type": 0

}

'@

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

`

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