Versions Compared

Key

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

General Information

...

ServiceAPIMethodData ModelWorkflowGroup
multitenant/product/packagePUTProductsN/AProduct

Description 

Update product package

Input

...

Type: application/json


Name
Source
Mandatory
Type
Special Format
Description
idQueryYESStringN/AThe product id
codeQueryYESStringThe Length is 4 - 5The product code
nameBodyYESStringN/AThe product name
descriptionBodyNOStringN/AThe product description
_TTLBodyNOString
'6', '12', '24', '48', '72', '96', '120', '144', '168'

tagsBodyNOArrayArray of strings
aclBodyNOObject

ACL Schema

Package ACL - Check the example below
typeBodyNOObjectKeys are environment codes and value is granularEnvironment ACL TYPE

ACL Example

Code Block
languagejs
titleACL Input example
linenumberstrue
collapsetrue
 "acl": {
  "dashboard": {
    "oauth": [
      {
        "version": "1",
        "get": [
          "Guest"
        ],
        "post": [
          "Guest",
          "Tokenization"
        ],
        "delete": [
          "Tokenization"
        ]
      }
    ]
  }
}


Type Example

Code Block
languagejs
titleACL Input example
linenumberstrue
collapsetrue
 {
	"dashboard": "granular"
}


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: 'product package %package_code% updated successfully' 
}

Invalid Response

Code Block
languagejs
titleError Response Sample
linenumberstrue
collapsetrue
{
    "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
400

Business logic required data are missing

460
Unable to find products
461

Unable to find package

500

This record is locked. You cannot modify or delete it

602
Model error: + %model_error%