Versions Compared

Key

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

General Information

...

ServiceAPIMethodData ModelWorkflow
multitenant/productGET

...

...

N/A

Input

...

Type: application/json


Name
Source
Mandatory
Type
Special Format
Description
idQueryYESNOStringN/AThe product id
codeBodyQueryYESNOStringThe Length is 4 - 5The product code


...

Code Block
languagejs
titleValid Response Sample
{
    "resultcode" : true,
  "dataTPROD":,
{     "_idname" : "5d776ce4e8c4bb0424e3bc7dTest Product",
    "lockeddescription" : true,"this is a description for "code": "DSBRDtest product",
    "nameconsole": "Console UI Product"false,
    "descriptionscope": "This is{
the main Console UI Product.",     "consoleacl": true,{
    "scope": {       "acldashboard": {
        "dashboard": {
          "uracmultitenant": {
            "2": {      "1": {
       "access": true,               "apisPermissionaccess": "restricted"false,
                       "get": [
                  {         {
         "group": "Administration",                      "apis": {
                    "/admin/all": {                       "access"/product": true{
                    },
                    "/admin/listUsersaccess": {false
                      "access": true            }
        },                     "/admin/changeUserStatus": { },
                     "access": true         "group": "Product"
          },                 }
   "/admin/group/list": {                   ]
   "access": true               },
     }              "1x2": {
   }                 },      "access": true,
        ],               "postget": [
                {           {
          "group": "Administration",                     "apis": {
  
                 "/admin/addUser": {                       "access"/tenant": true{
                    },                     "/admin/editUser"access": {false
                      "access": true            }
        },                     "/admin/group/add": { },
                     "access": true         "group": "Tenant"
          },                 }
   "/admin/group/edit": {                   ],
   "access": true                   "post": [
}                   }        {
        }               ],               "delete"apis": [{
                {                   "group/tenant": "Administration",{
                  "apis": {                     "/admin/group/delete"access": {true
                          "access": true        }
            }                   },
                }               ]
"group": "Tenant"
           }           },     }
     "multitenant": {             "1": {   ]
           "access": false,       }
       "get": [       },
         {      "urac": {
           "group": "Product"        "1": {
            },           "access": true,
    {                   "groupapisPermission": "Tenantrestricted",
                }       "get": [
      ],                "post": [    {
            {                   "groupapis": "Product" {
                   },                "/user": {
                   "group": "Tenant"                 }  "access": false
           ],                "put": [       }
         {                   "group": "Product"  },
              },                 {"group": "Administrator"
                  "group": "Tenant"        }
        }               ],
               "delete": [   },
             {      "2x5": {
           "group": "Product"           "access": true,
    },                 {  "apisPermission": "restricted",
               "group": "Tenant"       "post": [
        }               ]    {
        }           }         }   "apis": {
  }     },     "packages": [       {
        "code": "DSBRD_OWNER",         "name/account/changeEmail": "Owner", {
                                       "descriptionaccess": "Thistrue
 package is used to provide owner level access. This means the user who has this package will have access to everything.",
                },
                                   "/account/changePassword": {
                                       "access": true
                                   },
                                   "/account/editProfile": {
                                       "access": true
                                   }
                               },
                               "group": "My Account"
                           }
                       ],
                       "get": [
                           {
                               "apis": {
                                   "/account/getUser": {
                                       "access": true
                                   }
                               },
                               "group": "My Account"
                           }
                       ]
                   }
               }
           }
        }
    },
    "packages" : [
        {
            "code" : "TPROD_BASIC",
            "name" : "basic package",
            "description" : "this is a description for test product basic package",
            "acl" : {
                "dashboard": {
                    "multitenant": [
                        {
                            "version": "1",
                            "get": [
                                "Product"
                            ]
                        },
                        {
                            "version": "1.2",
                            "get": [
                                "Tenant"
                            ]
                        }
                    ],
                    "urac": [
                        {
                            "version": "1",
                            "get": [
                                "Administrator",
                            ]
                        },
                        {
                            "version": "3",
                            "get": [
                                "Administrator",
                                "My Account",
                            ]
                        }
                    ]
      "locked": true,         "acl": {}
            "dashboard":},
            "urac_TTL" : [86400000 // 24 hours
        },
   {     {
            "versioncode" : "2TPROD_EXAMPLE03",
            "name" : "example03  "get": [package",
            "description" : "this is a description for test product example03  package"Administration",
            "acl" :  {
],                 "postdashboard": [{
                    "Administrationurac",: [
               ],         {
       "delete":  [                   "Administrationversion": "2.5",
               ]               }
    "get": [
       ],             "multitenant": [           "My Account",
  {                 "version": "1",        ],
        "get": [                   "Productput",: [
                 "Tenant"               "My Account",
],                  "post": [         ],
         "Product",                   "Tenantdelete": [
               ],                 "delete": [
My Account",
                 "Product",           ],
       "Tenant"                  ],   "post": [
            "put": [                   "ProductMy Account",
                   "Tenant"         ]
         ]               }
            ]        ]
  }          },    }
    "_TTL": 604800000       },
            "_TTL" : 21600000
86400000 // 24 hours
     }   }
 ]   }]
}


Invalid Response

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

...

Code Block
languagebash
titleCalling List Products API
 > CURL -X GET http://127.0.0.1:40044000/multitenant/product?id=%product_id%

Response

...