Versions Compared

Old Version 8

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

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/items

GET

N/A

N/A

Description

This API lists the items matching certain keywords from soajs catalog only.

...

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

querystring

Specify the type of catalog

types

query

Noquery

Array of strings

Specify the types of catalog

...

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": "
5e409c94c5a59210a815262c
5f33ab670c7c214f927453c6",
        "
name
type": "
pay
service",
        "
configuration": { "subType"
name": "
ecommerce
controller",

        "
port
configuration":
4102,
{
          "
group
subType": "
Marketplace
soajs",
          "
requestTimeout
port":
30
4000,
          "
requestTimeoutRenewal
group":
5, "maintenance": { "port": { "type": "maintenance" 
"Gateway"
        
},

        "
readiness
versions":
"/heartbeat"
[
} 
{
},
     
"
description
version": "
MS pay service for marketplace
1",
"metadata":
{ 
   
"
tags
maintenance":
[ 
{
"order",
"ecommerce" ], "program": [ "marketplace"
"readiness": "/heartbeat",
]
}, "settings
"port": {
"acl":
{
"public": { "ro": true
"type": "maintenance"
}
 
},
"recipes":
[],
      
"
environments
commands":
{} 
[
},
"src":
 {
"provider":
"github", 
       
"
owner
label": "
ht
Reload Provision",
"repo":
"mkpl.order"
}, "type
"path": "
service
/loadProvision",
"ui":
{
           "
main
icon": "
Gateway
fas fa-download"
,
"sub": "" 
      
},
"versions":
[
           {
"version":
"1",
"extKeyRequired": true, "oauth": true, "provision_ACL": false, 
"label": "Reload Registry",
"tenant_Profile":
false,
             "
urac
path":
false,
"urac_ACL": false
"/reloadRegistry",
"urac_Config":
false, 
     "
urac_GroupConfig
icon":
false,
"urac_Profile": false, "apis": [
"fas fa-undo"
{
 },
"l": "pay items",
 {
"v": "/pay", "m
 "label": "
post", "group": "Pay" }
Reload Awareness",
{
"l
"path": "
Get all pay 
/awarenessStat",
"v":
"/pays",
"m
"icon": "
get
fas fa-wifi"
,
"group": "Pay" 
}
}
  
]
,
"documentation":
{
}
          }
        ]
      },
    ],
    "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

...