Update solution

1min

PATCH
/developer/solutions/versions/{solutionVersionId}
This endpoint follows JSON Merge Patch standard. This means when setting a field to null, it gets deleted (or reset to default value). Providing a new value overwrites the field. Caution is advised while setting a field, as it can overwrite nested members. For the api field, be extra careful and provide an updated object with all necessary endpoints.
The following table shows the fields in a solution which can be updated and by whom.
FieldUpdates After Tech Review ApprovedDeletable / Resettable to default
displayNameAny org memberNo
shortDescriptionAny org memberNo
longDescriptionAny org memberYes
isConsoleCompatibleProduct admin onlyYes
visibilityProduct admin or Publisher onlyYes
categoriesAny org memberYes
solnUrlsAny org memberYes
apiProduct admin onlyYes
Notes:
This endpoint does not support updating the apps on a solution. To edit apps use the endpoint: /developer/solutions/versions/{solutionVersionId}/apps.
To delete an array, set the field to null as you would for any field. Setting to [] will return an error.
Access: API can be accessed by users who are part of the org to which the solution belongs.
Path Parameters
solutionVersionId
string
*
Header Parameters
x-developerplatform-access
string
*
Body Parameters
body
UpdateSolutionRequestDTO
*
displayName
string
shortDescription
string
isConsoleCompatible
boolean
longDescription
string
visibility
object
All Of
SolutionVisibilityDTO  +
categories
string[]
solnUrls
SolutionUrlDTO[]
systemAppSettings
string[]
api
object
All Of
SolutionApiDTO  +
productFamily
string
Responses
200
EmptyDTO
400
Something is wrong in the request content
BadRequestErrorResponseDTO
error
BadRequestErrorDTO
*
request
StandardRequestDTO
*
403
User not authorized on the solution's organization
ForbiddenErrorResponseDTO
error
ForbiddenErrorDTO
*
request
StandardRequestDTO
*
404
Solution version not found
NotFoundErrorResponseDTO
error
NotFoundErrorDTO
*
request
StandardRequestDTO
*
Curl
JS
Ruby
Python
curl --location --globoff --request PATCH '/developer/solutions/versions/{solutionVersionId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "solnUrls": [
    {
      "name": "",
      "url": ""
    }
  ]
}'
curl --location --globoff --request PATCH '/developer/solutions/versions/{solutionVersionId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "solnUrls": [
    {
      "name": "",
      "url": ""
    }
  ]
}'
Responses
200
400
403
404
{}
{}
﻿
﻿

Field	Updates After Tech Review Approved	Deletable / Resettable to default
displayName	Any org member	No
shortDescription	Any org member	No
longDescription	Any org member	Yes
isConsoleCompatible	Product admin only	Yes
visibility	Product admin or Publisher only	Yes
categories	Any org member	Yes
solnUrls	Any org member	Yes
api	Product admin only	Yes

Updated 10 Oct 2024

Did this page help you?

Get Solution By Version ID

Delete Solution Version