...
...
General Information
...
| Service | API | Method | Data Models | Workflow | Group |
|---|---|---|---|---|---|
| multitenant | /tenant/application/key | POST | Tenant | N/A | Tenant |
Description
Add key to a tenant application with optional ext key
Input
...
Type: application/json
| Name | Source | Mandatory | Type | Special Format | Description | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| appId | Body | YES | String | N/A | Application ID | ||||||||||||||||||||||||||||||
| config | Body | NO | ObjectN/A | Tenant Key Configuration | Key Configuration | ||||||||||||||||||||||||||||||
| extKey | Body | NO | Object | Application External 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: 1true
} |
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 |
| 472 | Unable to get the tenant application |
| 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% |