Versions Compared

Key

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

...

...

...

...

...

General Information

...

ServiceAPIMethodData ModelsWorkflowGroup
multitenant/tenant/applicationPUTTenantN/ATenant

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 external key sent in the request headers.Update tenant application

Input

...

Type: application/json
NameSourceMandatoryTypeSpecial FormatDescription
descriptionBodyNOStringN/AApplication Description
appIdBodyYESStringN/AApplication ID
_TTLBodyNOStringN/ATime To Live

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

472Unable to get the tenant application
500

You cannot modify or delete a locked record

602Model error: + %model_error%