Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 10 Next »

General Information


Service
API
Method
Data Model
Workflow
multitenant/productPOSTProductsN/A

Input


Type: application/json
Name
Source
Mandatory
Type
Special Format
Description
codeBodyYESStringThe length is between 4 - 5Product code
nameBodyYESStringN/AProduct name
descriptionBodyNOStringN/A

Product description

scopeBodyNOObjectScope Schema Product Scope - Below Example will 

Scope Example

Scope Input example Expand source
"scope": {
  "acl": {
     "dashboard": {
       "multitenant": {
          "1": {
            "access": false,
            "get": [
               {
                   "/product": {
                       "access": false
                   },
                   "group": 'Product'
               }
            ]
          },
          "2.1" : {
             "access": false,
             "get": [
               {
                     "/product": {
                         "access": false
                     },
                     "group": 'Product'
               }
            ]
         }
       }
     }
   }
}

Output


Response

SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response 

Valid Response

Valid Response Sample Expand source
{
    "result": true,
    "data": [
        {
            "name": "Fadi2",
            "code": "FADI2",
            "description": "Some Description",
            "scope": {
                "acl": {
					"dashboard": {
						"multitenant": {
                                "1": {
                                    "access": false,
                                    "get": [
                                        {
                                            "/product": {
                                                "access": false
                                            },
                                            "group": 'Product'
                                        }
                                    ]
                                },
                                "2.1" : {
                                    "access": false,
                                    "get": [
                                        {
                                            "/product": {
                                                "access": false
                                            },
                                            "group": 'Product'
                                        }
                                    ]
                                }
                            }
					}
				}
            },
            "packages": [],
            "_id": "5d6fedabbed68d11b6f54636"
        }
    ]
}

Invalid Response

Error Response Sample Expand source
{
    "result":false,
    "errors":{
        "codes":[468],
        "details":[
            {
                "code":468,
                "message":"Product already exists"
            }
        ]
    }
}

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes


Code
Description
400

Business logic required data are missing

468

Product already exists

602
Model error: + %model_error%
  • No labels