Versions Compared

Old Version 2

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.

...

Code Block
Type: application/json

Input

Source

Required

Type

Description

start

query

No

integer - minimium= 0

To control the pagination starting record

limit

query

No

integer - maximum= 2000

To control the pagination limit

keywords

query

No

string

To search by keywords

type

query

No

string

Specify the type of catalog

types

query

No

Array of strings

Specify the types of catalog

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": {
    "limit": 10,
    "start": 0,
    "size": 1,
    "records": [
      {
        "_id": "5f33ab670c7c214f927453c6",
        "type": "service",
        "name": "controller",
        "configuration": {
          "subType": "soajs",
          "port": 4000,
          "group": "Gateway"
        },
        "versions": [
          {
            "version": "1",
            "maintenance": {
              "readiness": "/heartbeat",
              "port": {
                "type": "maintenance"
              },
              "commands": [
                {
                  "label": "Reload Provision",
                  "path": "/loadProvision",
                  "icon": "fas fa-download"
                },
                {
                  "label": "Reload Registry",
                  "path": "/reloadRegistry",
                  "icon": "fas fa-undo"
                },
                {
                  "label": "Reload Awareness",
                  "path": "/awarenessStat",
                  "icon": "fas fa-wifi"
                }
              ]
            }
          }
        ]
      },
    ],
    "count": 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%