POST - /tenant/application
General Information
Service | API | Method | Data Models | Workflow | Group |
|---|---|---|---|---|---|
multitenant | /tenant/application | POST | N/A | Tenant |
Description
Add application to tenant with optional key and ext key
Input
Type: application/json
Name | Source | Mandatory | Type | Special Format | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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
Valid Response Sample
{
result: true,
data: {"internalKey": "%internal_key%", "externalKey" : "%external_key%"}
}Invalid Response
Error Response Sample
{
"result":false,
"errors":{
"codes":[602],
"details":[
{
"code":602,
"message":"Model error: + %model_error%"
}
]
}
}Response schema
Follow this link to check out the response JSON Schema
SOAJS Error Codes
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% |