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 |
Sample Output
Output
...
Response
SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response
Valid Response
Expand |
---|
|
Code Block |
---|
| {
"result": true,
"data": {
"limit": 10,
"start": 0,
"size": 1,
"records": [
{
"_id": "5f33ab670c7c214f927453c6",
|
|
...
"type": "service",
"name": " |
|
...
controller",
"configuration": {
"subType": " |
|
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
"readiness": "/heartbeat" |
|
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Invalid Response
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
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% |