Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

General Information

...

ServiceAPIMethodData ModelWorkflowGroup
multitenant/product/scopePUT

Data Model: 

...

ProductsN/AProduct

Description

Update product ACL scope

Input

...

Type: application/json

...


Name
Source
Mandatory
Type
Special Format
Description
idQueryYESStringN/AThe product id
acl
ScopeBody
NO
YESObject
Product ACL
Scope Schema
BodyYESObject
Product Scope

Output

- Check the example below

Scope Example


Code Block
languagejs
title

...

{

}

Invalid Response

...

languagejs
titleError Response Sample

...

Scope Input example
linenumberstrue
collapsetrue
"scope": {
  "acl": {
     "dashboard": {
       "multitenant": {
          "1": {
     

...

       "access": false,
            "

...

get": [
               {
        

...

           "/product": {
                       "access": false
                   },
                   "group": 'Product'
               }
            ]
          },
          

...

"2.1" : {
             "access": false,
             "get": [
               {
                     "/product": {
                         "

...

access": false
                     },
                     "

...

group":

...

 'Product'
               }
            ]
         }
       }
     }

...

Code

...

Description

...

426

...

460

...

Unable to find products

...

466

...

475

...

Unable to remove product record

...

477

...

Invalid product code provided

...

500

...

This record is locked. You cannot modify or delete it

Example (CURL)

Request

...

languagebash
titleCalling List Products API

...

   }
}

Output

...

Response

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

Valid Response

Code Block
languagejs
titleValid Response Sample
linenumberstrue
collapsetrue
{ 
	result: true,
  	data: true
}

Invalid Response

Code Block
languagejs
titleError Response Sample
linenumberstrue
collapsetrue
{
    "result":false,
    "errors":{
        "aclcodes": {},[460],
        "scopedetails":[
    {},
}

Response

Code Block
languagejs
titleList Products API response
{        {
                "resultcode": true,460,
                "datamessage":"Unable to [find products"
     {       }
        ]
}    ]
}}
}

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes



Code
Description
400

Business logic required data are missing

460

Unable to find products

500

This record is locked. You cannot modify or delete it

602
Model error: + %model_error%