Versions Compared

Key

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

General Information

...

ServiceAPIMethod
multitenant/product/packagePOST


Data Model: 

Workflow:

Input

...

Type: application/json


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

aclBodyNOObject

Product ACL


Output

...

Valid Response

Code Block
languagejs
titleValid Response Sample
{

}


Invalid Response

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



Error Codes



Code
Description
426
Invalid Product ID provided
437

Unable to get the environment records

460
Unable to find products
467

Package already exists

473

Missing required fields

476

Unable to update product record

500

This record is locked. You cannot modify or delete it



Example (CURL)

...

Request

Code Block
languagebash
titleCalling List Products API
 > CURL -X POST http://127.0.0.1:4004/product?id=%product_id% -d {
    "code": "SOME",
    "name": "Some",
    "description": "package description",
	"_TTL": "18",
	"acl": {}
}

Response

Code Block
languagejs
titleList Products API response
{
   "result": true,
   "data": [
      {
         
      }
   ]
}