Core
Solutions
Solutions APIs are components of our comprehensive suite of endpoints designed to automate Software Development Life Cycle (SDLC) processes for embedded integrations. For a complete SDLC pipeline implementation, start with our Projects APIs documentation, as Projects APIs handle the core integration logic and configuration. Solutions APIs then manage how changes are applied to solution instances.
After importing a project into the target environment:
- Use the Get Publish Preview API to validate the impact of publishing the draft solution. This step highlights any potential breaking changes.
- Use the Publish Solution API to publish the solution draft. Solution instances will automatically upgrade if no breaking changes are detected.
- When breaking changes are present, additional steps are required to upgrade existing solution instances. For managing these upgrades, refer to the Solution Instances APIs documentation.
Embedded Deployment:
- Project import updates the draft solution
- Publishing solution required to apply changes to existing solution instances
- May require manual solution instance upgrades in case of breaking changes
Publish solution
Publishes the draft solution. If no breaking changes are detected, solution instances are automatically upgraded to the published version. Otherwise, a manual upgrade is required.
Response Examples
{
"releaseId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"breakingChanges": true,
"requiresNewUserInput": true,
"requiresNewSystemInput": true,
"authSlots": {
"created": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"authenticationId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"description": "string",
"serviceId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"serviceEnvironmentId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scopes": [
"string"
],
"externalId": "string",
"static": true,
"hidden": true,
"skipCTA": true,
"requireUnique": true,
"hasBreakingChange": true,
"changes": [
{
"message": "string",
"code": "CreatedMandatorySlot",
"breakingChange": true
}
],
"recreated": true,
"slotRecreationReasons": [
{
"code": "AuthenticationIdChanged",
"message": "string"
}
],
"recreatedFromSlotId": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"updated": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"description": "string",
"authenticationId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"serviceId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"serviceEnvironmentId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scopes": [
"string"
],
"externalId": "string",
"static": true,
"hidden": true,
"skipCTA": true,
"requireUnique": true,
"hasBreakingChange": true,
"changes": [
{
"message": "string",
"code": "CreatedMandatorySlot",
"breakingChange": true
}
],
"previously": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"description": "string",
"authenticationId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"serviceId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"serviceEnvironmentId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scopes": [
"string"
],
"externalId": "string",
"static": true,
"hidden": true,
"skipCTA": true,
"requireUnique": true
}
}
],
"removed": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"description": "string",
"authenticationId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"serviceId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"serviceEnvironmentId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scopes": [
"string"
],
"externalId": "string",
"static": true,
"hidden": true,
"skipCTA": true,
"requireUnique": true
}
]
},
"configSlots": {
"created": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"key": "string",
"title": "string",
"description": "string",
"externalId": "string",
"valueType": "string",
"ddl": true,
"ddlConfiguration": {
"allowSetCustomValue": true
},
"required": true,
"useDefaultValue": true,
"defaultValue": null,
"referencedAuthSlotId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"static": true,
"hidden": true,
"hasCustomJs": true,
"hasDataMapping": true,
"disabledResetType": true,
"hasBreakingChange": true,
"changes": [
{
"message": "string",
"code": "CreatedMandatorySlot",
"breakingChange": true
}
],
"recreated": true,
"slotRecreationReasons": [
{
"code": "ConfigVariableKeyChanged",
"message": "string"
}
],
"recreatedFromSlotId": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"updated": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"key": "string",
"title": "string",
"description": "string",
"externalId": "string",
"valueType": "string",
"ddl": true,
"ddlConfiguration": {
"allowSetCustomValue": true
},
"required": true,
"useDefaultValue": true,
"defaultValue": null,
"referencedAuthSlotId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"static": true,
"hidden": true,
"hasCustomJs": true,
"hasDataMapping": true,
"disabledResetType": true,
"hasBreakingChange": true,
"changes": [
{
"message": "string",
"code": "CreatedMandatorySlot",
"breakingChange": true
}
],
"previously": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"key": "string",
"title": "string",
"description": "string",
"externalId": "string",
"valueType": "string",
"ddl": true,
"ddlConfiguration": {
"allowSetCustomValue": true
},
"required": true,
"useDefaultValue": true,
"defaultValue": null,
"referencedAuthSlotId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"static": true,
"hidden": true,
"hasCustomJs": true,
"hasDataMapping": true,
"disabledResetType": true
}
}
],
"removed": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"key": "string",
"title": "string",
"description": "string",
"externalId": "string",
"valueType": "string",
"ddl": true,
"ddlConfiguration": {
"allowSetCustomValue": true
},
"required": true,
"useDefaultValue": true,
"defaultValue": null,
"referencedAuthSlotId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"static": true,
"hidden": true,
"hasCustomJs": true,
"hasDataMapping": true,
"disabledResetType": true
}
]
}
}Get publish preview
Check impact on destination solution ahead of publishing
Response Examples
{
"releaseId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"breakingChanges": true,
"requiresNewUserInput": true,
"requiresNewSystemInput": true,
"authSlots": {
"created": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"authenticationId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"description": "string",
"serviceId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"serviceEnvironmentId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scopes": [
"string"
],
"externalId": "string",
"static": true,
"hidden": true,
"skipCTA": true,
"requireUnique": true,
"hasBreakingChange": true,
"changes": [
{
"message": "string",
"code": "CreatedMandatorySlot",
"breakingChange": true
}
],
"recreated": true,
"slotRecreationReasons": [
{
"code": "AuthenticationIdChanged",
"message": "string"
}
],
"recreatedFromSlotId": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"updated": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"description": "string",
"authenticationId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"serviceId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"serviceEnvironmentId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scopes": [
"string"
],
"externalId": "string",
"static": true,
"hidden": true,
"skipCTA": true,
"requireUnique": true,
"hasBreakingChange": true,
"changes": [
{
"message": "string",
"code": "CreatedMandatorySlot",
"breakingChange": true
}
],
"previously": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"description": "string",
"authenticationId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"serviceId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"serviceEnvironmentId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scopes": [
"string"
],
"externalId": "string",
"static": true,
"hidden": true,
"skipCTA": true,
"requireUnique": true
}
}
],
"removed": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"description": "string",
"authenticationId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"serviceId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"serviceEnvironmentId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scopes": [
"string"
],
"externalId": "string",
"static": true,
"hidden": true,
"skipCTA": true,
"requireUnique": true
}
]
},
"configSlots": {
"created": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"key": "string",
"title": "string",
"description": "string",
"externalId": "string",
"valueType": "string",
"ddl": true,
"ddlConfiguration": {
"allowSetCustomValue": true
},
"required": true,
"useDefaultValue": true,
"defaultValue": null,
"referencedAuthSlotId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"static": true,
"hidden": true,
"hasCustomJs": true,
"hasDataMapping": true,
"disabledResetType": true,
"hasBreakingChange": true,
"changes": [
{
"message": "string",
"code": "CreatedMandatorySlot",
"breakingChange": true
}
],
"recreated": true,
"slotRecreationReasons": [
{
"code": "ConfigVariableKeyChanged",
"message": "string"
}
],
"recreatedFromSlotId": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"updated": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"key": "string",
"title": "string",
"description": "string",
"externalId": "string",
"valueType": "string",
"ddl": true,
"ddlConfiguration": {
"allowSetCustomValue": true
},
"required": true,
"useDefaultValue": true,
"defaultValue": null,
"referencedAuthSlotId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"static": true,
"hidden": true,
"hasCustomJs": true,
"hasDataMapping": true,
"disabledResetType": true,
"hasBreakingChange": true,
"changes": [
{
"message": "string",
"code": "CreatedMandatorySlot",
"breakingChange": true
}
],
"previously": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"key": "string",
"title": "string",
"description": "string",
"externalId": "string",
"valueType": "string",
"ddl": true,
"ddlConfiguration": {
"allowSetCustomValue": true
},
"required": true,
"useDefaultValue": true,
"defaultValue": null,
"referencedAuthSlotId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"static": true,
"hidden": true,
"hasCustomJs": true,
"hasDataMapping": true,
"disabledResetType": true
}
}
],
"removed": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"key": "string",
"title": "string",
"description": "string",
"externalId": "string",
"valueType": "string",
"ddl": true,
"ddlConfiguration": {
"allowSetCustomValue": true
},
"required": true,
"useDefaultValue": true,
"defaultValue": null,
"referencedAuthSlotId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"static": true,
"hidden": true,
"hasCustomJs": true,
"hasDataMapping": true,
"disabledResetType": true
}
]
}
}