Versions Compared

Key

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

General Information

...

ServiceAPIMethodData ModelsWorkflow
multitenant/admin/tenant/application/key/extKeyPUTTenantN/A

Description

This API updates the external key that matches the one sent in the request body and exists in the application record and the tenant that have the ids that match the ones sent in the query.

Input

...

Type: application/json
NameSourceMandatoryTypeSpecial FormatDescription
idQueryYESStringN/ATenant ID
appIdBodyYESStringN/AApplication ID
keyBodyYESStringN/AKey
extKeyBodyYESStringN/AExternal Key

expDate

BodyNOStringdate-timeExpiry date
labelBodyNOStringN/AKey Label

extKeyEnv

BodyNOStringN/AExternal Key Environment
deviceBodyNOObjectN/ADevice information
geoBodyNOObjectN/AGeo-Location information

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: 1	true
}

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

500

You cannot modify or delete a locked record

602Model error: + %model_error%