POST - /admin/tenant/application

Owned by Fadi Nasr (Unlicensed)
Last updated: Sept 07, 2020 by Ragheb Bou Dargham (Unlicensed)

General Information

ServiceAPIMethodData ModelsWorkflowGroup
multitenant/admin/tenant/applicationPOSTTenantN/AAdmin Tenant

Description

Add application to tenant with optional key and ext key

Input

Type: application/json
NameSourceMandatoryTypeSpecial FormatDescription
idQueryYESStringN/ATenant ID
productCodeBodyYESStringN/AProduct code
packageCodeBodyYESStringN/APackage code
descriptionBodyNOStringN/AApplication description
_TTLBodyYESString

"enum": ['6', '12', '24', '48', '72', '96', '120', '144', '168']

Time To Live
appKeyBodyNOObject
Application Key

NameMandatoryTypeSpecial FormatDescription
configNOObjectTenant Key ConfigurationKey Configuration
extKeyNOObjectN/AExternal Key Configuration

NameMandatoryTypeSpecial FormatDescription
labelYESStringN/AKey label
envYESStringN/AEnvironment
expDateNOStringdate-timeExpiry Date
deviceNOObjectN/ADevice Config
geoNOObjectN/AGeo Location

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: {
		intKey: "%internal_key%",
		extKey: "%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

602Model error: + %model_error%