...
...
General Information
...
| Service | API | Method | Data Model | Workflow | Group |
|---|---|---|---|---|---|
| multitenant | /product/console/package | POST |
Data Model:
...
| Products | N/A | Console product |
Description
Add a package to console product
Input
...
Type: application/json
Name | Source | Mandatory | Type | Special Format | Description |
|---|---|---|---|---|---|
| id | Query | YES | String | N/A | The product id |
| code | QueryBody | NO | String | The Length is 4 - 5 | The product package code |
| name | Body | YES | StringThe product | N/A | The package name |
| description | Body | NO | StringThe product | N/A | The package description |
| _TTL | Body | YES | String | '6', '12', '24', '48', '72', '96', '120', '144', '168' | |
| tags | Body | NO | Array | Array of strings | |
| acl | Body | NO | Object | Product |
Output
Valid Response
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
} |
Invalid Response
| Package ACL - Check the example below | |||||
| type | Body | NO | Object | Keys are environment codes and value is granular | Environment ACL TYPE |
ACL Example
| Code Block | |||
|---|---|---|---|
|
...
| |||||
"acl": { " |
...
dashboard": |
...
{ " |
...
oauth": [ { " |
...
version": |
...
"1", " |
...
get": [ "Guest" ], |
...
"post": [ " |
...
Guest" |
...
, "Tokenization" |
...
], "delete": [ "Tokenization" ] |
...
} |
...
] } } |
...
Code
...
Description
...
426...
437...
Unable to get the environment records
...
460...
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
...
| language | bash |
|---|---|
| title | Calling List Products API |
...
Type Example
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"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 | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
result: true,
data: 'package_code'
} |
Invalid Response
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{ "result":false, "errors":{ "codecodes": "SOME",[460], "namedetails":[ "Some", "description": "package description", "_TTL": "24", "acl": {} } |
Response
| Code Block | ||||
|---|---|---|---|---|
| ||||
{ "resultcode": true,460, "datamessage":"Unable [to find products" { } ] } ] }} } |
Code | Description |
|---|---|
400 | Business logic required data are missing |
460 | Unable to find products |
467 | Package already exists |
500 | This record is locked. You cannot modify or delete it |
602 | Model error: + %model_error% |