Versions Compared

Old Version 13

changes.mady.by.user antoine hage

Saved on

compared with

New Version Current

changes.mady.by.user Ragheb Bou Dargham (Unlicensed)

Saved on

Key

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

General Information

...

Service

API

Method

Data Models

Workflow

marketplace

/item/deploy/configure

PUT

N/A

N/A

Description

This API updates the deployment configuration of an item.

...

Param

Source

Type

Required

Description

label

body.config.recipe.sourceCode

string

Yes conditional

catalog

body.config.recipe.sourceCode

string

Yes conditional

id

body.config.recipe.sourceCode

string

Yes conditional

version

body.config.recipe.sourceCode

string

Yes conditional

branch

body.config.recipe.sourceCode

string

Yes conditional

tag

body.config.recipe.sourceCode

string

Yes conditional

commit

body.config.recipe.sourceCode

string

Yes conditional

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": "Catalog Item Configuration Successfully updated!"
}

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

405

Recipe not allowed for this item!

406

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

501

Item not found!

602

Model error: + %model_error%

603

Model item not updated!