Get Solution By Listing ID

1min
GET
/developer/solutions
This API is used to get solution details and all versions of the solution by listingId.
Header Parameters
x-developerplatform-access
string
*
Query Parameters
listingId
string
*
organizationId
undefined
*
Responses
200
SolutionDTO
solutionId
string
*
versions
SolutionVersionDTO[]
*
solutionType
string<APP | API>
productFamily
string
*
supportedCountries
string[]
*
organizationId
string
*
403
User does not have access to the solution's org
ForbiddenErrorResponseDTO
error
ForbiddenErrorDTO
*
request
StandardRequestDTO
*
404
Solution not found based on provided solution version id
NotFoundErrorResponseDTO
error
NotFoundErrorDTO
*
request
StandardRequestDTO
*
Curl
JS
Ruby
Python
curl --location '/developer/solutions?listingId=string&organizationId=undefined' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location '/developer/solutions?listingId=string&organizationId=undefined' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
403
404
{
  "solutionId": "solution:b31414f1-bc40-42c9-bcc0-ed7a47126441",
  "versions": [
    {
      "createdAt": "",
      "createdBy": "",
      "updatedAt": "",
      "updatedBy": "",
      "isCopyrightFree": true,
      "displayName": "Vehicle Routing",
      "longDescription": "This is a solution for vehicle routing used to optimize routes for delivery",
      "shortDescription": "This is a solution for vehicle routing",
      "isConsoleCompatible": true,
      "solutionId": "solutionversion:b31414f1-bc40-42c9-bcc0-ed7a47126441",
      "solutionVersionId": "solutionversion:b31414f1-bc40-42c9-bcc0-ed7a47126441",
      "version": "1.0.0",
      "categories": [
        ""
      ],
      "phase": "DRAFT",
      "images": [
        {
          "artifactId": "470d7bb7-4136-4fa5-8806-85d5f7ee2548",
          "fileName": "icon.png",
          "fileDescription": "",
          "fileUrl": "https://my-app.com/icon.png",
          "filePath": "myapp/icon.png"
        }
      ],
      "icon": [
        {
          "artifactId": "470d7bb7-4136-4fa5-8806-85d5f7ee2548",
          "fileName": "icon.png",
          "fileDescription": "",
          "fileUrl": "https://my-app.com/icon.png",
          "filePath": "myapp/icon.png"
        }
      ],
      "documents": [
        {
          "category": "DRAFT",
          "document": {}
        }
      ],
      "configurations": [
        {
          "category": "solution-configuration",
          "configurationFile": {}
        }
      ],
      "applications": [
        {
          "appId": "app:bf17e158-1951-47f9-84f1-e50aeb59fac2",
          "appVersionId": "appversion:bf17e158-1951-47f9-84f1-e50aeb59fac2",
          "displayOrder": 1,
          "initSequence": 1,
          "listingId": "",
          "semver": ""
        }
      ],
      "solutionInitializationConfiguration": {},
      "visibility": {},
      "solnUrls": [
        {
          "name": "landingPage",
          "url": "https://www.example.com/landing-page"
        }
      ],
      "systemAppSettings": [
        ""
      ],
      "apis": [
        {
          "apiBaseUrl": "https://api.example.com",
          "apiDetails": [
            {
              "name": "Geocoder V1",
              "relativePath": "geocoder/v1"
            }
          ]
        }
      ],
      "listingId": ""
    }
  ],
  "solutionType": "APP",
  "productFamily": "",
  "supportedCountries": [
    ""
  ],
  "organizationId": ""
}
{
  "solutionId": "solution:b31414f1-bc40-42c9-bcc0-ed7a47126441",
  "versions": [
    {
      "createdAt": "",
      "createdBy": "",
      "updatedAt": "",
      "updatedBy": "",
      "isCopyrightFree": true,
      "displayName": "Vehicle Routing",
      "longDescription": "This is a solution for vehicle routing used to optimize routes for delivery",
      "shortDescription": "This is a solution for vehicle routing",
      "isConsoleCompatible": true,
      "solutionId": "solutionversion:b31414f1-bc40-42c9-bcc0-ed7a47126441",
      "solutionVersionId": "solutionversion:b31414f1-bc40-42c9-bcc0-ed7a47126441",
      "version": "1.0.0",
      "categories": [
        ""
      ],
      "phase": "DRAFT",
      "images": [
        {
          "artifactId": "470d7bb7-4136-4fa5-8806-85d5f7ee2548",
          "fileName": "icon.png",
          "fileDescription": "",
          "fileUrl": "https://my-app.com/icon.png",
          "filePath": "myapp/icon.png"
        }
      ],
      "icon": [
        {
          "artifactId": "470d7bb7-4136-4fa5-8806-85d5f7ee2548",
          "fileName": "icon.png",
          "fileDescription": "",
          "fileUrl": "https://my-app.com/icon.png",
          "filePath": "myapp/icon.png"
        }
      ],
      "documents": [
        {
          "category": "DRAFT",
          "document": {}
        }
      ],
      "configurations": [
        {
          "category": "solution-configuration",
          "configurationFile": {}
        }
      ],
      "applications": [
        {
          "appId": "app:bf17e158-1951-47f9-84f1-e50aeb59fac2",
          "appVersionId": "appversion:bf17e158-1951-47f9-84f1-e50aeb59fac2",
          "displayOrder": 1,
          "initSequence": 1,
          "listingId": "",
          "semver": ""
        }
      ],
      "solutionInitializationConfiguration": {},
      "visibility": {},
      "solnUrls": [
        {
          "name": "landingPage",
          "url": "https://www.example.com/landing-page"
        }
      ],
      "systemAppSettings": [
        ""
      ],
      "apis": [
        {
          "apiBaseUrl": "https://api.example.com",
          "apiDetails": [
            {
              "name": "Geocoder V1",
              "relativePath": "geocoder/v1"
            }
          ]
        }
      ],
      "listingId": ""
    }
  ],
  "solutionType": "APP",
  "productFamily": "",
  "supportedCountries": [
    ""
  ],
  "organizationId": ""
}
﻿
﻿
Updated 10 Oct 2024
Did this page help you?
Delete Solution Version