Register Solution

1min
POST
This API is used to register a new solution.
If the user is part of more than one organization they MUST specify the orgId in the query parameter.
Header Parameters
x-developerplatform-access
string
*
Query Parameters
orgId
string
Body Parameters
body
RegisterSolutionRequestDTO
*
displayName
string
*
solnListingId
string
*
type
string<APP | API>
*
version
string
*
shortDescription
string
*
isConsoleCompatible
boolean
*
longDescription
string
*
visibility
object
All Of
SolutionVisibilityDTO  +
productFamily
string
supportedCountries
string[]
*
categories
string[]
*
solnUrls
SolutionUrlDTO[]
*
apps
SolutionApplicationRequestDTO[]
*
api
object
*
All Of
SolutionApiDTO  +
systemAppSettings
string[]
Responses
201
Returns the newly created solution
RegisterSolutionResponseDTO
id
object
*
All Of
SolutionVersionIdentifierDTO  +
400
Something is wrong in the request content
BadRequestErrorResponseDTO
error
BadRequestErrorDTO
*
request
StandardRequestDTO
*
403
User not authorized on provided organization
ForbiddenErrorResponseDTO
error
ForbiddenErrorDTO
*
request
StandardRequestDTO
*
404
Organization found
NotFoundErrorResponseDTO
error
NotFoundErrorDTO
*
request
StandardRequestDTO
*
Curl
JS
Ruby
Python
curl --location '/developer/solutions' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "displayName": "",
  "solnListingId": "",
  "type": "",
  "version": "",
  "shortDescription": "",
  "isConsoleCompatible": false,
  "longDescription": "",
  "supportedCountries": [
    ""
  ],
  "categories": [
    ""
  ],
  "solnUrls": [
    {
      "name": "",
      "url": ""
    }
  ],
  "apps": [
    {
      "listingId": "",
      "semver": ""
    }
  ],
  "api": {}
}'
curl --location '/developer/solutions' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "displayName": "",
  "solnListingId": "",
  "type": "",
  "version": "",
  "shortDescription": "",
  "isConsoleCompatible": false,
  "longDescription": "",
  "supportedCountries": [
    ""
  ],
  "categories": [
    ""
  ],
  "solnUrls": [
    {
      "name": "",
      "url": ""
    }
  ],
  "apps": [
    {
      "listingId": "",
      "semver": ""
    }
  ],
  "api": {}
}'
Responses
201
400
403
404
// Returns the newly created solution 
{
  "id": {}
}
// Returns the newly created solution 
{
  "id": {}
}
﻿
﻿
Updated 10 Oct 2024
Did this page help you?
Get Solution By Listing ID
Add a new version to a solution