...
...
General Information
...
| Service | API | Method | Data Model | Workflow | Group |
|---|---|---|---|---|---|
| multitenant | /product/console/package | POST | Products | N/A | Console product |
Description
This API adds a package to the product that has an id that matches the one sent in the query.Add console package to product
Input
...
Type: application/json
Name | Source | Mandatory | Type | Special Format | Description |
|---|---|---|---|---|---|
| id | Query | YES | String | N/A | The product id |
| code | Body | NO | String | The Length is 4 - 5 | The package code |
| name | Body | YES | String | N/A | The package name |
| description | Body | NO | String | 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 | 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"
]
}
]
}
} |
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":{
"codes":[460],
"details":[
{
"code":460,
"message":"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% |