1. Overview
Microservice containing the business logic for managing templates of external config service definitions.
2. Resources
2.1. Action-controller
Action Controller
2.1.1. Create an Action
POST /v1/actions
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
204 |
No Content, Error retrieving actions |
|
400 |
Bad Request |
|
401 |
User Unauthorized |
|
409 |
Action name {actionName} already exists |
|
500 |
Internal Server Error |
2.1.2. Get Actions
GET /v1/actions
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
actionId |
actionId |
integer (int64) |
|
Query |
includeDeleted |
includeDeleted |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< ActionResponse > array |
204 |
No Content, Error retrieving actions |
|
400 |
Bad Request |
|
401 |
User Unauthorized |
|
500 |
Internal Server Error |
2.1.3. Update an Action
PUT /v1/actions/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
id |
integer (int64) |
Body |
actionRequest |
actionRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content, Error retrieving actions |
|
400 |
Bad Request |
|
401 |
User Unauthorized |
|
404 |
Action with id {id#} doesn’t exist |
|
409 |
Action name {actionName} already exists |
|
500 |
Internal Server Error |
2.1.4. Delete an Action
DELETE /v1/actions/{id}
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
204 |
No Content, Error retrieving actions |
|
400 |
Bad Request |
|
401 |
User Unauthorized |
|
404 |
Action with id {id#} doesn’t exist |
|
500 |
Internal Server Error |
2.2. Action-type-controller
Action Type Controller
2.2.1. Create an ActionType
POST /v1/actionTypes
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
204 |
No Content, Error retrieving actions |
|
400 |
Bad Request |
|
401 |
User Unauthorized |
|
409 |
ActionType name {actionTypeName} already exists |
|
500 |
Internal Server Error |
2.2.2. Get ActionTypes
GET /v1/actionTypes
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
actionTypeId |
actionTypeId |
integer (int64) |
|
Query |
includeDeleted |
includeDeleted |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< ActionType > array |
201 |
Created |
|
204 |
No Content, Error retrieving actionTypes |
|
400 |
Bad Request |
|
401 |
User Unauthorized |
|
500 |
Internal Server Error |
2.2.3. Update an ActionType
PUT /v1/actionTypes/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
id |
integer (int64) |
Body |
actionTypeRequest |
actionTypeRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content, Error retrieving actions |
|
400 |
Bad Request |
|
401 |
User Unauthorized |
|
404 |
ActionType with id {id#} doesn’t exist |
|
500 |
Internal Server Error |
2.2.4. Delete an ActionType
DELETE /v1/actionTypes/{id}
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
204 |
No Content, Error retrieving actions |
|
400 |
Bad Request |
|
401 |
User Unauthorized |
|
404 |
ActionType with id {id#} doesn’t exist |
|
500 |
Internal Server Error |
2.3. Call-controller
Call Controller
2.3.1. Create configuration for given action
POST /v1/configurations
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
externalConfigRequest |
External config data Object |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
400 |
Invalid data supplied |
|
401 |
User Unauthorized |
No Content |
404 |
Action/ActionType/Configuration is not found |
|
409 |
Conflict, configuration already exists. Use a PUT to update |
|
500 |
Internal Server Error |
2.3.2. Get Configurations
GET /v1/configurations
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
actionId |
actionId |
integer (int32) |
|
Query |
actionName |
actionName |
string |
|
Query |
actionTypeId |
actionTypeId |
integer (int32) |
|
Query |
configId |
configId |
integer (int64) |
|
Query |
includeDeleted |
includeDeleted |
boolean |
|
Query |
page |
page |
integer (int32) |
|
Query |
size |
size |
integer (int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content, Error retrieving actions |
|
401 |
User Unauthorized |
No Content |
500 |
Internal Server Error |
2.3.3. Update configuration for given action
PUT /v1/configurations/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
id |
integer (int64) |
Body |
externalUpdateConfigRequest |
External config data Object |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid data supplied |
|
401 |
User Unauthorized |
No Content |
404 |
Not Found, Action/ActionType/Configuration is not valid |
|
500 |
Internal Server Error |
2.3.4. Delete Configuration
DELETE /v1/configurations/{id}
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
400 |
Invalid data supplied |
|
401 |
User Unauthorized |
No Content |
404 |
Configuration details not found |
|
500 |
Internal Server Error |
2.4. Parameter-controller
Parameter Controller
2.4.1. Get Parameters
GET /v1/parameters
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
id |
id |
string |
|
Query |
includeCustomProperties |
includeCustomProperties |
boolean |
|
Query |
name |
name |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< ParameterResponse > array |
204 |
No Content, Error retrieving parameters |
|
401 |
User Unauthorized |
No Content |
500 |
Internal Server Error |
2.5. Tab-controller
Tab Controller
2.5.1. Create association by tabId, appId
POST /apps
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
201 |
Created |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
409 |
Conflict |
|
422 |
Unprocessable Entity |
|
500 |
Internal Server error |
2.5.2. Update sequenceOrder, enable/disable of tabs mapped to app
PUT /apps/{appId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
appId |
appId |
integer (int64) |
Body |
body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Response |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
|
500 |
Internal Server error |
2.5.3. Get tabs details mapped to appId
GET /apps/{appId}/tabs
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
appId |
appId |
integer (int64) |
|
Query |
enabled |
enabled |
integer (int32) |
|
Query |
page |
page |
integer (int32) |
|
Query |
size |
size |
integer (int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
204 |
No Content, Error retrieving actions |
|
401 |
User Unauthorized |
No Content |
500 |
Internal Server Error |
2.5.4. Get tabs and apps associated details
GET /apps/{appId}/tabs/{tabId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
appId |
appId |
integer (int64) |
Path |
tabId |
tabId |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
|
500 |
Internal Server error |
2.5.5. Create a tab
POST /tabs
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
201 |
Created |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
409 |
Conflict |
|
422 |
Unprocessable Entity |
|
500 |
Internal Server error |
2.5.6. Get all or standard or custom tab details
GET /tabs
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
page |
page |
integer (int32) |
|
Query |
size |
size |
integer (int32) |
|
Query |
tabType |
tabType |
enum (All, Standard, Custom) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
204 |
No Content, Error retrieving actions |
|
401 |
User Unauthorized |
No Content |
500 |
Internal Server Error |
2.5.7. Get tab by Id
GET /tabs/{tabId}
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
204 |
No Content, Error retrieving actions |
|
401 |
User Unauthorized |
No Content |
500 |
Internal Server Error |
2.5.8. Update tab details by Id
PUT /tabs/{tabId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
tabId |
tabId |
integer (int64) |
Body |
body |
body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Response |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
|
500 |
Internal Server error |
2.5.9. Delete a Tab
DELETE /tabs/{tabId}
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
400 |
Invalid data supplied |
|
401 |
User Unauthorized |
No Content |
404 |
Tab details not found |
|
500 |
Internal Server Error |
2.5.10. Get apps mapped to tabId
GET /tabs/{tabId}/apps
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
tabId |
tabId |
integer (int64) |
|
Query |
page |
page |
integer (int32) |
|
Query |
size |
size |
integer (int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
204 |
No Content, Error retrieving actions |
|
401 |
User Unauthorized |
No Content |
500 |
Internal Server Error |
2.5.11. Delete Tab & App association
DELETE /tabs/{tabId}/apps/{appId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
appId |
appId |
integer (int64) |
Path |
tabId |
tabId |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
400 |
Invalid data supplied |
|
401 |
User Unauthorized |
No Content |
404 |
Tab details not found |
|
500 |
Internal Server Error |
3. Definitions
3.2. ActionResponse
| Name | Schema |
|---|---|
createdBy |
string |
createdOn |
string |
deleted |
boolean |
description |
string |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string |
name |
string |
3.3. ActionType
| Name | Schema |
|---|---|
createdBy |
string |
createdOn |
string (date-time) |
deleted |
boolean |
description |
string |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
name |
string |
3.5. ActionTypeResponse
| Name | Schema |
|---|---|
createdBy |
string |
createdOn |
string |
deleted |
boolean |
description |
string |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string |
name |
string |
3.6. CustomTabConfigResource
| Name | Schema |
|---|---|
appId |
integer (int64) |
enabled |
integer (int32) |
links |
< Link > array |
sequenceOrder |
integer (int32) |
tab |
3.7. CustomTabConfigResponse
| Name | Description | Schema |
|---|---|---|
appId |
integer (int64) |
|
createdBy |
string |
|
createdOn |
string |
|
enabled |
Minimum value : |
integer (int32) |
id |
integer (int64) |
|
lastModifiedBy |
string |
|
lastModifiedOn |
string |
|
sequenceOrder |
integer (int32) |
|
tab |
3.8. CustomTabConfigResults
| Name | Schema |
|---|---|
content |
< CustomTabConfigResource > array |
links |
< Link > array |
page |
3.9. CustomTabResource
| Name | Description | Schema |
|---|---|---|
configData |
||
configExpression |
string |
|
createdBy |
string |
|
createdOn |
string |
|
description |
string |
|
displayName |
string |
|
id |
integer (int64) |
|
lastModifiedBy |
string |
|
lastModifiedOn |
string |
|
links |
< Link > array |
|
standard |
Minimum value : |
integer (int32) |
3.10. CustomTabResults
| Name | Schema |
|---|---|
content |
< CustomTabResource > array |
links |
< Link > array |
page |
3.12. ExternalConfigRequest
| Name | Schema |
|---|---|
actionId |
integer (int64) |
actionTypeId |
integer (int64) |
data |
object |
3.13. ExternalConfigResource
| Name | Schema |
|---|---|
actionId |
integer (int64) |
actionName |
string |
actionType |
string |
actionTypeId |
integer (int64) |
configId |
integer (int64) |
createdBy |
string |
createdOn |
string |
data |
object |
deleted |
boolean |
id |
integer (int64) |
lastModifiedOn |
string |
links |
< Link > array |
updatedBy |
string |
3.14. ExternalConfigResponse
| Name | Schema |
|---|---|
actionId |
integer (int64) |
actionName |
string |
actionType |
string |
actionTypeId |
integer (int64) |
configId |
integer (int64) |
createdBy |
string |
createdOn |
string |
data |
object |
deleted |
boolean |
id |
integer (int64) |
lastModifiedOn |
string |
updatedBy |
string |
3.15. ExternalConfigResponsePage
| Name | Schema |
|---|---|
content |
< Resource«ExternalConfigResponse» > array |
links |
< Link > array |
page |
3.16. ExternalConfigUpdateRequest
| Name | Schema |
|---|---|
actionId |
integer (int64) |
actionTypeId |
integer (int64) |
data |
object |
3.19. PageMetadata
| Name | Schema |
|---|---|
number |
integer (int64) |
size |
integer (int64) |
totalElements |
integer (int64) |
totalPages |
integer (int64) |
3.20. ParameterResponse
| Name | Schema |
|---|---|
customProperty |
boolean |
dataType |
string |
id |
string |
name |
string |
propertyCategoryId |
string |
propertyGroupId |
string |
3.21. Resource«ExternalConfigResponse»
| Name | Schema |
|---|---|
actionId |
integer (int64) |
actionName |
string |
actionType |
string |
actionTypeId |
integer (int64) |
configId |
integer (int64) |
createdBy |
string |
createdOn |
string |
data |
object |
deleted |
boolean |
id |
integer (int64) |
lastModifiedOn |
string |
links |
< Link > array |
updatedBy |
string |
3.23. TabAuthorizationRequest
| Name | Schema |
|---|---|
authentication |
boolean |
enableSeriallot |
boolean |
externalLink |
string |
inputParams |
string |
password |
string |
username |
string |
3.24. TabDataRequest
| Name | Schema |
|---|---|
enabled |
integer (int32) |
sequenceOrder |
integer (int32) |
tabId |
integer (int64) |
3.25. TabRequest
| Name | Schema |
|---|---|
configData |
|
configExpression |
string |
description |
string |
displayName |
string |
standard |
integer (int32) |
3.26. TabResponse
| Name | Description | Schema |
|---|---|---|
configData |
||
configExpression |
string |
|
createdBy |
string |
|
createdOn |
string |
|
description |
string |
|
displayName |
string |
|
id |
integer (int64) |
|
lastModifiedBy |
string |
|
lastModifiedOn |
string |
|
standard |
Minimum value : |
integer (int32) |
4. Security
4.1. access_token
Type : oauth2
Flow : accessCode
Token URL : https://10.181.213.73/uaa/oauth/authorize
Token URL : https://10.181.213.73/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.2. resource_owner
Type : oauth2
Flow : password
Token URL : https://10.181.213.73/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.3. implicit_grant
Type : oauth2
Flow : implicit
Token URL : https://10.181.213.73/uaa/oauth/authorize
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.4. client_creds
Type : oauth2
Flow : application
Token URL : https://10.181.213.73/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |