Versions Compared

Key

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

General Information

...

Service
 ServiceAPIMethod
multitenant
Data ModelWorkflowGroup
 multitenant/products/consoleGET

Workflow:

...

ProductsN/AConsole Product

Description

List console products

Input

...

Type: application/son

No input data for this 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
collapsetrue
 {
  "result": true,
  "data": [
    {
      "_id": "5512867be603d7e01ab1688d5d7764841e2c4b034b43ceea",
      "locked": true,
      "code": "DSBRD",
      "name": "Console UI Product",
      "description": "This is the main Console UI Product.",
      "scopeconsole": {true,
          "aclscope": {
              "dashboard"acl": {
          "dashboard":        {
				"urac": {
					"2":                      "2": {
                          {
						"access": true,
						"apisPermission": "restricted",
						"get": [
							{
								"group": "Administration",
								"apis": {
									"/admin/all": {
										"access": true,
                          "apisPermission": "restricted",
                          "get": [
                              {
                                  "group": "Administration",
                                  "apis": {
                                      "/admin/all": {
                                          "access": true
                                      }
                                  }
                              },
                          ],
                          "post": [
                              {
                                  "group": "My Account",
                                  "apis": {
                                      "/account/changeEmail": {
                                          "access": true
                                      }
                                  }
                     
									},
									"/admin/listUsers": {
										"access": true
									},
									"/admin/changeUserStatus": {
										"access": true
									},
									"/admin/group/list": {
										"access": true
									}
								}
							},
							{
								"group": "My Account",
								"apis": {
									"/account/getUser": {
										"access": true
									}
								}
							},
							{
								"group": "Guest Password Settings",
								"apis": {
									"/forgotPassword": {
										"access": false
									}
								}
							},
							{
								"group": "Guest Email Validation",
								"apis": {
									"/changeEmail/validate": {
										"access": true
									}
								}
							}
						],
						"post": [
							{
								"group": "My Account",
								"apis": {
									"/account/changeEmail": {
										"access": true
									},
									"/account/changePassword": {
										"access": true
									},
									"/account/editProfile": {
										"access": true
									}
								}
							},
							{
								"group": "Administration",
								"apis": {
									"/admin/addUser": {
										"access": true
									},
									"/admin/editUser": {
										"access": true
									},
									"/admin/group/add": {
										"access": true
									},
									"/admin/group/edit": {
										"access": true
									}
								}
							},
							{
								"group": "Guest Password Settings",
								"apis": {
									"/resetPassword": {
										"access": false
									}
								}
							}
						],
						"delete": [
							{
								"group": "Administration",
								"apis": {
									"/admin/group/delete": {
										"access": true
									}
								}
							}
						]
					}
				},
				"dashboard": {
					"1": {
						"access": false,
						"post": [
							{
								"group": "Continuous Delivery Deployment",
								"apis": {
									"/cd/deploy": {
										"access": false
									}
								}
							}
						]
					}
				},
				"oauth": {
					"1": {
						"access": true,
						"apisPermission": "restricted",
						"delete": [
							{
								"group": "Tokenization",
								"apis": {
									"/refreshToken/:token": {
										"access": true
									},
									"/accessToken/:token": {
										"access": true
									}
								}
							},
							{
								"group": "User Tokenization",
								"apis": {
									"/tokens/user/:userId": {
										"access": true
									}
								}
							},
							{
								"group": "Cient Tokenization",
								"apis": {
									"/tokens/tenant/:clientId": {
										"access": true
									}
								}
							}
						],
						"post": [
							{
								"group": "Tokenization",
								"apis": {
									"/pin": {
										"access": true
									}
								}
							},
							{
								"group": "Guest",
								"apis": {
									"/token": {
										"access": false
									}
								}
							}
						],
						"get": [
							{
								"group": "Guest",
								"apis": {
									"/authorization": {
										"access": false
									}
								}
							}
						]
					}
				},
				"multitenant": {
					"1": {
						"access": false,
						"get": [
							{
								"group": "Product"
							},
							{
								"group": "Tenant"
							},
						],
						"post": [
							{
								"group": "Product"
							},
							{
								"group": "Tenant"
							},
						],
						"put": [
							{
								"group": "Product"
							},
							{
								"group": "Tenant"
							},
						],
						"delete": [
							{
								"group": "Product"
							},
							{
								"group": "Tenant"
							},
						]
					}
				},
			}
        },
      },
      "packages": [
        {
          "code": "DSBRD_GUEST",
          "name": "Guest",
         ], "description": "This package is used to provide anyone access to login and forgot password. Once logged in the package linked to the user tenant will take "delete": [
        over thus providing the right access to the logged in user.",
          "acl": {
            "dashboard": {
              "urac": [
                {
  "group": "Administration",               "version": "2",
                  "apispost": {[
                    "Guest Password Settings"
               "/admin/group/delete": {   ],
                  "get": [
                    "access": trueGuest Password Settings",
                    "Guest Email Validation"
                  ]
},                }
              ],
       "/admin/user/delete": {      "multitenant": [
                {
                  "accessversion": true"1",
                  "get": [
                  }  "Product",
                    "Tenant"
           }       ],
                  "post": [
   }                 "Product",
         ],           "Tenant"
               "put": [  ],
                  "delete": [
        {            "Product",
                    "Tenant"
 "group": "Administration",                ],
                  "apisput": [
  {                  "Product",
                    "/admin/changeUserStatusTenant":
{                  ]
                }
       "access": true      ]
            }
          },
        },  "_TTL": 604800000
        },
        {
          "code": "DSBRD_OWNER",
 }         "name": "Owner",
          "description": "This package is used to provide owner level access. }This means the user who has this package will have access to everything.",
          "acl": {
  ]          "dashboard": {
            }  "oauth": [
               } {
             }     "version": "1",
    }       },       "packagesget": [
         {           "codeGuest": "DSBRD_GUEST",
             "name": "Guest",    ],
      "locked": true,           "descriptionpost": "This[
package is used to provide anyone access to login and forgot password. Once logged in the package linked to the user tenant will take over"Guest",
thus providing the right access to the logged in user.",           "aclTokenization":
  {               "dashboard": { ],
                  "uracdelete": [
                    "Tokenization",
 {                   "User Tokenization",
      "version": "2",              "Cient Tokenization"
              "post": [   ]
                }
          "Guest Password Settings"  ],
              "urac": [
        ],        {
                  "getversion": ["2",
                  "get": [
           "Guest Password Settings",       "Guest Email Account Settings",
                    "Guest Email ValidationAdministration",
                    "My Account",
    ]                "Guest Password Settings",
    }                "Guest Email Validation"
]               }   ],
       },           "_TTLpost": [
 604800000         }       ]   "Administration",
 }   ] }

Invalid Response

Code Block
languagejs
titleError Response Sample
{     "result":false,     "errors":{     "My Account",
           "codes":[460],         "details":[Guest Password Settings"
                  ],
 {                 "codedelete":460, [
                    "messageAdministration":"Unable
 to find products"             }  ]
      ]     }
}

...

Example (CURL)

Request

Code Block
languagebash
titleCalling List Console Products API
 > CURL -X GET http://127.0.0.1:4004/products/console

Response

Code Block
languagejs
titleList Console Products API response
{
   "result": true,
   "data": [
      {     }
              ],
              "dashboard": [
                {
                  "version": "1",
                  "get": [
                    "Environment",
                  ],
                  "post": [
                    "Environment",
                  ],
                  "put": [
                    "Environment",
                  ],
                  "delete": [
                    "Environment",
                  ]
                }
              ],
              "multitenant": [
                {
                  "version": "1",
                  "get": [
                    "Product",
                    "Tenant"
                  ],
                  "post": [
                    "Product",
                    "Tenant"
                  ],
                  "delete": [
                    "Product",
                    "Tenant"
                  ],
                  "put": [
                    "Product",
                    "Tenant"
                  ]
                }
              ]
            }
          },
          "_TTL": 604800000
        }
      ]
    }
  ]
}

Invalid Response

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

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes



 CodeDescription
 602Model error: + %model_error%