GET - /soajs/items

Description

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

Input

Type: application/json

Input	Source	Required	Description
start	query	No	To control the pagination starting record
limit	query	No	To control the pagination limit
keywords	query	No	To search by keywords
type	query	query	Specify the type of catalog
`types`	query	query	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

{
  "result": true,
  "data": {
    "limit": 10,
    "start": 0,
    "size": 1,
    "records": [
      {
        "_id": "5e409c94c5a59210a815262c",
        "name": "pay",
        "configuration": {
          "subType": "ecommerce",
          "port": 4102,
          "group": "Marketplace",
          "requestTimeout": 30,
          "requestTimeoutRenewal": 5,
          "maintenance": {
            "port": {
              "type": "maintenance"
            },
            "readiness": "/heartbeat"
          }
        },
        "description": "MS pay service for marketplace",
        "metadata": {
          "tags": [
            "order",
            "ecommerce"
          ],
          "program": [
            "marketplace"
          ]
        },
        "settings": {
          "acl": {
            "public": {
              "ro": true
            }
          },
          "recipes": [],
          "environments": {}
        },
        "src": {
          "provider": "github",
          "owner": "ht",
          "repo": "mkpl.order"
        },
        "type": "service",
        "ui": {
          "main": "Gateway",
          "sub": ""
        },
        "versions": [
          {
            "version": "1",
            "extKeyRequired": true,
            "oauth": true,
            "provision_ACL": false,
            "tenant_Profile": false,
            "urac": false,
            "urac_ACL": false,
            "urac_Config": false,
            "urac_GroupConfig": false,
            "urac_Profile": false,
            "apis": [
              {
                "l": "pay items",
                "v": "/pay",
                "m": "post",
                "group": "Pay"
              },
              {
                "l": "Get all pay ",
                "v": "/pays",
                "m": "get",
                "group": "Pay"
              }
            ],
            "documentation": {}
          }
        ]
      }
    ],
    "count": 1
  }
}

Invalid Response

{
    "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%