General Information
...
| Service | API | Method | Data Models | Workflow |
|---|
| multitenancy | /tenants | GET |
Workflow: List Tenants Flow
Input
...
Type: application/json
| Name | Source | Mandatory | Type | Special Format | Description |
|---|
| N/A | N/A | N/A | N/A | N/A | This API does not need any parameters; it fetches all tenant records. |
Output
| type | Query | NO | String | "enum": ["product", "client"] | Tenant Type |
Output
...
Response
SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response
Valid Response
| Code Block |
|---|
| Code Block |
|---|
| language | js |
|---|
| title | Error Response Sample |
|---|
|
{
| language | js |
|---|
| title | Valid Response Sample |
|---|
|
{
"result": true,
"data": []
} |
Invalid Response
| linenumbers | true |
|---|
| collapse | true |
|---|
|
{
"result":false true,
data:
"errors":{ [
{
"codes":[436],_id: '5d7fa308d5ee5a3d2ca439da',
oauth: {
secret: "details":[
{%secret%",
redirectURI: "http://domain.com",
grants: [
"password",
"refresh_token"
],
disabled: 0,
type: 2.0,
loginMode: "urac"
},
"code":436 'test',
name: 'Test Tenant',
"message"description:"Unable to'this findis tenants."a description for test tenant',
applications: }[Array]
}
]
}
} |
...
Invalid Response
...
...
Request
| Code Block |
|---|
| language | bash |
|---|
| title | Calling List Groups API |
|---|
|
> CURL -X GET http://127.0.0.1:4004/tenants |
Response
| Code Block |
|---|
| language | js |
|---|
| title | List Groups API response |
|---|
|
{ |
...
| js | | title | Error Response Sample |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
|
{
"result":false,
"errors":{
"resultcodes": true,[436],
"datadetails":[
[ {
},"code":602,
{ "message":"Model error: + %model_error%"
}
]
}
} |
Response schema
Follow this link to check out the response JSON Schema
SOAJS Error Codes
| |
|---|
| 400 | Business logic required data are missing |
| 460 | Unable to find tenant |
| 602 | Model error: + %model_error% |