Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

General Information

...

ServiceAPIMethodData ModelsWorkflowGroup
multitenant

/tenant/application/key/ext

POSTTenantN/ATenant

Description

Add external key to tenant application

Input

...

Type: application/json

NameSourceMandatoryTypeSpecial FormatDescription
appIdBodyYESStringN/AApplication ID
keyBodyYESObjectN/AApplication Key
labelBodyYESStringN/AKey Label
envBodyYESStringN/AEnvironment Name
expDateBodyNOStringdate-timeexpiry Date
deviceBodyNOObjectN/ADevice config
geoBodyNOObjectN/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

Code Block
languagejs
titleValid Response Sample
linenumberstrue
collapsetrue
{ 
  result: true,
  data: 1true
}

Invalid Response

Code Block
languagejs
titleError Response Sample
linenumberstrue
collapsetrue
{
    "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

473

Unable to get the tenant application key

500

You cannot modify or delete a locked record

501

Environment record not found!

502

Unable to create External key

602Model error: + %model_error%