Configuration API
Kba list
Lists the deployed kbas.
GET/kbas/list
| Query parameters | sortByCategory(boolean,optional): if set to "true" the list will be sorted by Category. The default is "false" |
| Header | auth-token:token from authentication |
| Header/Parameter | tenant |
| Body | None |
| Returns | List<KbaEntryRest> |
| Required role | USER |
| Managed errors | 401: insufficient privileges |
Example request
curl 'http://localhost:8080/mwp/rest/kbas/list' -H 'auth-token: 4a9c5a8a-fb55-443b-b93f-3c87ec2881de' -H 'tenant:default'
Example response
{
"defaultKba":null,
"kbas":[
{
"id":"031d33e3-22c6-4589-bedb-b7709250a8b3",
"name":"Test Summary",
"processKb":"fa3753d0-b204-4411-9bb8-8e1edff80bf3",
"comment":null,
"modifiedBy":"admin",
"modifiedOn":1441360475924,
"modifiedOnH":"2015-09-04 11:54:35",
"categories":[
],
"visibility":"RESTRICTED",
"summaryChecklistType":"PANEL",
"extensionConfiguration":{
"MatchBackendExtension":{
"icon":null,
"name":"Match Database Extension",
"version":1,
"applicationConfigurationItem":[
],
"serverConfigurationItem":null,
"mappingFiles":null,
"disabled":false
},
"document":{
"icon":null,
"name":"documentConf",
"version":1,
"applicationConfigurationItem":[
{
"name":"pageMargins",
"explanation":"Configuration items related to the page margins",
"subOptions":[
{
"name":"HtmlWidth",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":null,
"mandatory":true,
"type":null
},
{
"name":"MarginBottom",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":null,
"mandatory":true,
"type":null
},
{
"name":"MarginLeft",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":null,
"mandatory":true,
"type":null
},
{
"name":"MarginRight",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":null,
"mandatory":true,
"type":null
},
{
"name":"MarginTop",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":null,
"mandatory":true,
"type":null
}
]
}
],
"serverConfigurationItem":null,
"mappingFiles":null,
"disabled":false
},
"forwardExtension":{
"icon":null,
"name":"forwardExtension",
"version":1,
"applicationConfigurationItem":[
],
"serverConfigurationItem":null,
"mappingFiles":null,
"disabled":false
},
"dashboard":{
"icon":null,
"name":"Dashboard Extension",
"version":3,
"applicationConfigurationItem":[
{
"name":"Prefix",
"value":null,
"defaultValue":null,
"explanation":"Prefix to acces diferent schema",
"validationRegex":null,
"mandatory":false,
"type":null
},
{
"name":"Database name",
"value":null,
"defaultValue":null,
"explanation":"Name of the database",
"validationRegex":null,
"mandatory":false,
"type":null
}
],
"serverConfigurationItem":null,
"mappingFiles":null,
"disabled":false
},
"email":{
"icon":null,
"name":"SmtpServer",
"version":1,
"applicationConfigurationItem":[
{
"name":"pageMargins",
"explanation":"Configuration items related to the page margins",
"subOptions":[
{
"name":"HtmlWidth",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":"^[0-9]{1,}$",
"mandatory":true,
"type":null
},
{
"name":"MarginBottom",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":"^[0-9]{1,}$",
"mandatory":true,
"type":null
},
{
"name":"MarginLeft",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":"^[0-9]{1,}$",
"mandatory":true,
"type":null
},
{
"name":"MarginRight",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":"^[0-9]{1,}$",
"mandatory":true,
"type":null
},
{
"name":"MarginTop",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":"^[0-9]{1,}$",
"mandatory":true,
"type":null
}
]
}
],
"serverConfigurationItem":null,
"mappingFiles":null,
"disabled":false
}
},
"serverSideSave":null,
"xmlImportStrategy":"PREFILL",
"bookmarkConfiguration":null,
"processKbName":"Test summary.mplx",
"visualizationConfiguration":null,
"feedback":null,
"uiConfiguration":null
},
{
"id":"03a0de50-5a2b-4e3c-8cd4-ccab31827a5f",
"name":"Test summary No displays 2",
"processKb":"5d1af7c3-0093-4f5f-b604-3b338145aee2",
"comment":null,
"modifiedBy":"admin",
"modifiedOn":1453221911732,
"modifiedOnH":"2016-01-19 17:45:11",
"categories":[
],
"visibility":"RESTRICTED",
"summaryChecklistType":"PANEL",
"extensionConfiguration":{
"review":{
"icon":null,
"name":"Review Extension",
"version":1,
"applicationConfigurationItem":[
],
"serverConfigurationItem":null,
"mappingFiles":null,
"disabled":false
},
"MatchBackendExtension":{
"icon":null,
"name":"Match Database Extension",
"version":1,
"applicationConfigurationItem":[
],
"serverConfigurationItem":null,
"mappingFiles":null,
"disabled":false
},
"document":{
"icon":null,
"name":"documentConf",
"version":1,
"applicationConfigurationItem":[
{
"name":"pageMargins",
"explanation":"Configuration items related to the page margins",
"subOptions":[
{
"name":"HtmlWidth",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":null,
"mandatory":true,
"type":null
},
{
"name":"MarginBottom",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":null,
"mandatory":true,
"type":null
},
{
"name":"MarginLeft",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":null,
"mandatory":true,
"type":null
},
{
"name":"MarginRight",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":null,
"mandatory":true,
"type":null
},
{
"name":"MarginTop",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":null,
"mandatory":true,
"type":null
}
]
}
],
"serverConfigurationItem":null,
"mappingFiles":null,
"disabled":false
},
"forwardExtension":{
"icon":null,
"name":"forwardExtension",
"version":1,
"applicationConfigurationItem":[
],
"serverConfigurationItem":null,
"mappingFiles":null,
"disabled":false
},
"dashboard":{
"icon":null,
"name":"Dashboard Extension",
"version":3,
"applicationConfigurationItem":[
{
"name":"Prefix",
"value":null,
"defaultValue":null,
"explanation":"Prefix to acces diferent schema",
"validationRegex":null,
"mandatory":false,
"type":null
},
{
"name":"Database name",
"value":null,
"defaultValue":null,
"explanation":"Name of the database",
"validationRegex":null,
"mandatory":false,
"type":null
}
],
"serverConfigurationItem":null,
"mappingFiles":null,
"disabled":false
},
"email":{
"icon":null,
"name":"SmtpServer",
"version":2,
"applicationConfigurationItem":[
{
"name":"pageMargins",
"explanation":"Configuration items related to the page margins",
"subOptions":[
{
"name":"HtmlWidth",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":"^[0-9]{1,}$",
"mandatory":true,
"type":null
},
{
"name":"MarginBottom",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":"^[0-9]{1,}$",
"mandatory":true,
"type":null
},
{
"name":"MarginLeft",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":"^[0-9]{1,}$",
"mandatory":true,
"type":null
},
{
"name":"MarginRight",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":"^[0-9]{1,}$",
"mandatory":true,
"type":null
},
{
"name":"MarginTop",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":"^[0-9]{1,}$",
"mandatory":true,
"type":null
}
]
}
],
"serverConfigurationItem":null,
"mappingFiles":null,
"disabled":false
}
},
"serverSideSave":null,
"xmlImportStrategy":"PREFILL",
"bookmarkConfiguration":null,
"processKbName":"Test summary No displays 2.mplx",
"visualizationConfiguration":null,
"feedback":{
"enabled":false,
"subject":null,
"message":null,
"emailTo":null,
"emailFrom":null,
"ccToMySelf":null,
"limitSizeAttachment":0,
"emailFromUsername":null
},
"uiConfiguration":null
}
]
}