...
...
...
...
...
...
General Information
...
| Service | API | Method | Data Models | Workflow |
|---|---|---|---|---|
| multitenant | /tenant/application/key | PUT | Tenant | N/A |
Description
This API updates the internal key that matches the one sent in the request body and exists in the application record that has the appId that matches the one also sent in the request body and exists in the tenant that has the external key sent in the request headers.
Input
...
Type: application/json
| Name | Source | Mandatory | Type | Special Format | Description |
|---|---|---|---|---|---|
| appId | Body | YES | String | N/A | Application ID |
| key | Body | YES | String | N/A | Application Key |
| config | Body | YES | Object | Tenant Key Configuration | Key Config |
Tenant id will automatically be taken from the extKey (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: true
} |
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 |
| 473 | Unable to get the tenant application key |
| 500 | You cannot modify or delete a locked record |
| 602 | Model error: + %model_error% |