Versions Compared

Key

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

General Information

...

Service

API

Method

Data Model

Workflow

multitenant

/product/scope/env

PUT

Products

N/A

Description

This API updates the scope of the product record that has an id that matches the one sent in the query.

Input

...

Code Block
Type: application/json


Name

Source

Mandatory

Type

Special Format

Description

id

Query

YES

String

N/A

The product id

acl

Body

YES

Object

Part of Scope Schema

Product Scope - Check the example below

env

Query

YES

String

N/A

Environment code

Scope Example


Code Block
{
	"acl": {
		"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

Code Block
{ 
	result: true,
  	data: true
}

Invalid Response

Code Block
{
    "result":false,
    "errors":{
        "codes":[460],
        "details":[
            {
                "code":460,
                "message":"Unable to find products"
            }
        ]
    }
}

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes

...


Code

Description

Code Block
400

Business logic required data are missing

Code Block
460

Unable to find products

Code Block
500

This record is locked. You cannot modify or delete it

Code Block
602

Model error: + %model_error%