Versions Compared

Key

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

General Information

...

ServiceAPIMethodData ModelsWorkflowGroup
multitenancymultitenant/tenant/profile/PUTTenantN/ATenant

Description

Update tenant profile

Input

...

Type: application/json
NameSourceMandatoryTypeSpecial FormatDescription
idcodeQueryNOStringN/ATenant Code
QueryNOStringN/ATenant ID
profileBodyYESObjectN/ATenant Profile Object


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
languagejs
titleValid Response Sample
linenumberstrue
collapsetrue
{ 
  result: true,
  data:  d{}	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 response JSON Schema

SOAJS Error Codes



Code
Description
400

Business logic required data are missing

451

Tenant already exists

452

Main Tenant id is required!

453

Main Tenant is not found!

501Environment record not found!
450

Unable to find tenant

471

Unable to update tenant

500

You cannot modify or delete a locked record

602Model error: + %model_error%