Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

General Information

...

Service

API

Method

Data Models

Workflow

marketplace

/item/deploy/redeploy

PUT

N/A

N/A

Description

This API redeploys a deployed item, when you redeploy you have the option to change the following:

...

Param

Source

Type

Required

Description

type

query

string

yes

 

name

query

string

yes

 

env

query

string

yes

 

version

query

string

yes

 

image

body

Object

no

tag

body.image

string

yes

src

body

Object

no

from

body.src

Object

Yes

 
body.srceither tag or brach and commit must be specified.from

Conditional require, with one of the following:

  • ["tag"]

  • ["branch", "commit"]

Param

Source

Type

Required

Description

tag

body.src.from

string

conditional yes

branch

body.src.from

string

conditional yes

commit

body.src.from

string

conditional yes

body.image

Param

Source

Type

Required

Description

tag

body.image

string

yes

Output

...

Response

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

Valid Response

Expand
titleSAMPLE
Code Block
languagejson
{
  "result": true,
  "data": "Item Successfully Redeployed!
}

Invalid Response

Expand
titleSAMPLE
Code Block
{
    "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

400

Business logic required data are missing

406

You are not allowed to deploy this item in this environment!

407

The deploy configuration of this Environment was not found

410

The deploy configuration of this version was not found

413

Item not deployed!

421

Unable to connect to item

423

Unable to redeploy item!

501

Item is locked!

503

Service Error + + %service_error%

602

Model error: + %model_error%