Versions Compared

Old Version 1

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

/soajs/item/environments

PUT

N/A

N/A

Description

This API updates the item environments from soajs catalog only.

Input

...

Code Block
Type: application/json

Input

Source

Required

Type

Description

id

body

Yes

string

Specify the id of catalog

environments

body

Yes

Array of strings

Specify the environments this catalog have access to

type

body

Yes

string

Specify the type of access ( blacklist, whitelist)

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": 1
}

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

602

Model error: + %model_error%