Versions Compared

Version Old Version 1 New Version Current
Changes made by

antoine hage

Ragheb Bou Dargham

Saved on

Key

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

...

General Information

...

Service

API

Method

Data Models

Workflow

marketplace

/item/maintenance

PUT

N/A

N/A

Description

This API triggers maintenance operation on a deployed item.

Input

...

Code Block
Type: application/json

Input

Source

Required

Type

Description

name

query

Yes

string

Specify the name

env

query

Yes

string

Specify the env

type

query

Yes

string

Specify the type

version

query

Yes

string

Specify the version

operation

query

Yes

string

Specify the operation

port

body

Yes

object

body.port

Conditional require, with one of the following:

  • [“portType”]

  • ["portType", "portValue"]

Param

Source

Type

Required

Description

portType

body.port

string

Yes conditional

portValue

body.port

number

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": {
	id: "192.168.5.6",
	response: [{
		"id": "127.0.0.1",
		"response": {
			"result": true,
			"ts": 1596744199055,
			"service": {
				"service": "MARKETPLACE",
				"type": "rest",
				"route": "/heartbeat"
			},
			"versions": {
				"core": "4.0.14",
				"service": "1.0.15",
				"dependencies": {
					"async": "3.2.0",
					"soajs": "4.0.14"
				}
			}
		}
	}]
}

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

418

Item version not found!

419

No maintenance operations found for this Item version

420

Maintenance operation not found for this item version!

421

Unable to connect to item

550

loadByEnv empty. Unable to find registry

602

Model error: + %model_error%