Versions Compared

Key

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

...

...

...

...

General Information

...

ServiceAPIMethodData ModelsWorkflow
multitenancymultitenant/admin/tenant/applicationPUTTenantN/A

Description 

This API updates an application record that has the appId that matches the one sent in the request body and exists in the tenant that has the id that matches the one sent in the query.

Input

...

Type: application/json
NameSourceMandatoryTypeSpecial FormatDescription
idQuery
- extKey
NO
YESStringN/ATenant ID
code
description
Query -
BodyNOStringN/A
Tenant Code

...

Application Description
appIdBodyYESStringN/AApplication ID
_TTLBodyNOStringN/ATime To Live

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 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

472

Unable to get the tenant application

500

You cannot modify or delete a locked record

602Model error: + %model_error%