...
...
...
...
General Information
...
| Service | API | Method | Data Models | Workflow |
|---|---|---|---|---|
| multitenant | /admin/tenant/application | POST | Tenant | N/A |
Description
This API adds an application to the tenant that has the id that matches the one sent in the query. The application will be added under the product and the package that has the codes sent in the request body.
Input
...
Type: application/json
| Name | Source | Mandatory | Type | Special Format | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| id | Query | YES | String | N/A | Tenant ID | ||||||||||||||||||||||||||||||||||||||||||||||||||
| productCode | Body | YES | String | N/A | Product code | ||||||||||||||||||||||||||||||||||||||||||||||||||
| packageCode | Body | YES | String | N/A | Package code | ||||||||||||||||||||||||||||||||||||||||||||||||||
| description | Body | NO | String | N/A | Application description | ||||||||||||||||||||||||||||||||||||||||||||||||||
| _TTL | Body | YES | String | "enum": ['6', '12', '24', '48', '72', '96', '120', '144', '168'] | Time To Live | ||||||||||||||||||||||||||||||||||||||||||||||||||
| appKey | Body | NO | Object | Application Key | |||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Tenant id will automatically be taken from the extKey provided (tenant logged in from).
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: {
intKey: "%internal_key%",
extKey: "%external_key%"
}
} |
Invalid Response
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"result":false,
"errors":{
"codes":[602],
"details":[
{
"code":602,
"message":"Model error: + %model_error%"
}
]
}
} |
Code | Description |
|---|---|
| 400 | Business logic required data are missing |
| 450 | Unable to find tenant |
| 471 | Unable to update tenant |
| 500 | You cannot modify or delete a locked record |
| 501 | Environment record not found! |
| 502 | Unable to create External key |
| 602 | Model error: + %model_error% |