PUT - /item/deploy/cd

General Information

Service	API	Method	Data Models	Workflow

Service	API	Method	Data Models	Workflow
marketplace	/item/deploy/cd	PUT	N/A	N/A

Description

This API deploys an item used by CI

Input

Type: application/json

Param	Source	Type	Required	Description

Param	Source	Type	Required
token	query	string	yes
repo_token	query	string	no
name	query	string	yes
version	query	string	yes
type	query	string	yes
config	body	Object	yes
from	body.config	Object	yes

click here to learn more about SOAJS Smart Continuous Delivery

body.config.from

Conditional require, with one of the following:

["tag"]
["branch", "commit"]
["image_tag", "image_name", "image_prefix"]
["image_tag"]

Param	Source	Type	Required	Description

Param	Source	Type	Required
tag	body.config.from	string	conditional yes
branch	body.config.from	string	conditional yes
commit	body.config.from	string	conditional yes
image_name	body.config.from	string	conditional yes
image_tag	body.config.from	string	conditional yes
image_prefix	body.config.from	string	conditional yes
env	body.config.from	array	no

Output

Response

SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response

Valid Response

{
	"result": true,
	"data": {
		"stage_1": {
			"success": [
				"Deploy token authenticated Successfully"
			],
			"fail": []
		},
		"stage_2": {
			"success": [
				"Item found!"
			],
			"fail": []
		},
		"stage_3": {
			"success": [
				"Environments: NEW environments have been found"
			],
			"fail": []
		},
		"stage_4": {
			"success": [
				"Item Version 1 for environment NEW was selected with cd status deploy"
			],
			"fail": []
		},
		"stage_5": {
			"success": [
				"Item marketplace v 1 with cd status deploy in environment NEW has been successfully deployed"
			],
			"fail": []
		}
	}
}

Invalid Response

{
    "result":false,
    "errors":{
        "codes":[602],
        "details":[
            {
                "code":602,
                "message":"Model error: + %model_error%"
            }
        ]
    }
}

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes

Code	Description

Code	Description
400	Business logic required data are missing
503	Service Error: + %service_error”
602	Model error: + %model_error%