Configuration API
Read kba
Read one kba
GET/kbas/kbaId
| Query parameters | None |
| Header | auth-token:token from authentication |
| Header/Parameter | tenant |
| Body | None |
| Returns | KbaEntryRest |
| Required role | USER |
| Managed errors | 401: insufficient privileges |
Example request
curl 'http://localhost:8080/mwp/rest/kbas/031d33e3-22c6-4589-bedb-b7709250a8b3' -H 'auth-token: 7e3fe4c3-d18e-48d4-9c73-a2112c8902a2.local' -H 'tenant:default'
Example response
{
"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":7,
"applicationConfigurationItem":[
{
"name":"Prefix",
"value":null,
"defaultValue":null,
"explanation":"Prefix to acces diferent schema",
"validationRegex":null,
"mandatory":false,
"type":"NORMAL"
},
{
"name":"Database name",
"value":null,
"defaultValue":null,
"explanation":"Name of the database",
"validationRegex":null,
"mandatory":false,
"type":"NORMAL"
},
{
"name":"Log variables filters",
"explanation":"Configuration items related to the log of the consultation",
"subOptions":[
{
"name":"Consultation completed",
"value":"true",
"defaultValue":"true",
"explanation":"CONSULTATION_COMPLETED",
"validationRegex":"^(true|false)$",
"mandatory":true,
"type":"NORMAL"
},
{
"name":"Consultation finished",
"value":"true",
"defaultValue":"true",
"explanation":"CONSULTATION_FINISHED",
"validationRegex":"^(true|false)$",
"mandatory":true,
"type":"NORMAL"
},
{
"name":"Goal selection",
"value":"false",
"defaultValue":"false",
"explanation":"",
"validationRegex":"^(true|false)$",
"mandatory":true,
"type":"NORMAL"
},
{
"name":"Asked variables",
"value":"true",
"defaultValue":"true",
"explanation":"",
"validationRegex":"^(true|false)$",
"mandatory":true,
"type":"NORMAL"
},
{
"name":"Deduced variables",
"value":"false",
"defaultValue":"false",
"explanation":"",
"validationRegex":"^(true|false)$",
"mandatory":true,
"type":"NORMAL"
}
]
}
],
"serverConfigurationItem":[
{
"name":"Prefix",
"value":"",
"defaultValue":"",
"explanation":"Prefix to acces diferent schema",
"validationRegex":null,
"mandatory":false,
"type":"NORMAL"
},
{
"name":"Database name",
"value":null,
"defaultValue":null,
"explanation":"Name of the database",
"validationRegex":null,
"mandatory":true,
"type":"NORMAL"
}
],
"mappingFiles":null,
"disabled":false
},
"email":{
"icon":null,
"name":"SmtpServer",
"version":4,
"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":"NORMAL"
},
{
"name":"MarginBottom",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":"^[0-9]{1,}$",
"mandatory":true,
"type":"NORMAL"
},
{
"name":"MarginLeft",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":"^[0-9]{1,}$",
"mandatory":true,
"type":"NORMAL"
},
{
"name":"MarginRight",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":"^[0-9]{1,}$",
"mandatory":true,
"type":"NORMAL"
},
{
"name":"MarginTop",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":"^[0-9]{1,}$",
"mandatory":true,
"type":"NORMAL"
}
]
}
],
"serverConfigurationItem":[
{
"name":"manualOrJndi",
"explanation":"Manual configuration or JNDI",
"selected":null,
"alternatives":{
"jndi":[
{
"name":"JNDI",
"value":null,
"defaultValue":null,
"explanation":"The JNDI to look for the configuration in the application server",
"validationRegex":null,
"mandatory":false,
"type":"NORMAL"
},
{
"name":"From",
"value":null,
"defaultValue":null,
"explanation":"Default sender address",
"validationRegex":null,
"mandatory":false,
"type":"NORMAL"
}
],
"manual":[
{
"name":"SmtpServer",
"value":null,
"defaultValue":null,
"explanation":"The smtp server to use to send emails",
"validationRegex":null,
"mandatory":false,
"type":"NORMAL"
},
{
"name":"UserName",
"value":null,
"defaultValue":null,
"explanation":"The user name to access SMTP server",
"validationRegex":null,
"mandatory":false,
"type":"NORMAL"
},
{
"name":"Password",
"value":null,
"defaultValue":null,
"explanation":"The password to acces SMTP server",
"validationRegex":null,
"mandatory":false,
"type":"PASSWORD"
},
{
"name":"From",
"value":null,
"defaultValue":null,
"explanation":"Default sender address",
"validationRegex":null,
"mandatory":false,
"type":"NORMAL"
},
{
"name":"MailProperty1",
"value":null,
"defaultValue":null,
"explanation":"SMTP property for example mail.port",
"validationRegex":null,
"mandatory":false,
"type":"NORMAL"
},
{
"name":"MailProperty2",
"value":null,
"defaultValue":null,
"explanation":"SMTP property for example mail.smtp.from",
"validationRegex":null,
"mandatory":false,
"type":"NORMAL"
},
{
"name":"MailProperty3",
"value":null,
"defaultValue":null,
"explanation":"SMTP property for example mail.transport.protocol",
"validationRegex":null,
"mandatory":false,
"type":"NORMAL"
},
{
"name":"MailProperty4",
"value":null,
"defaultValue":null,
"explanation":"SMTP property for example mail.smtp.auth",
"validationRegex":null,
"mandatory":false,
"type":"NORMAL"
},
{
"name":"MailProperty5",
"value":null,
"defaultValue":null,
"explanation":"SMTP property for example mail.debug",
"validationRegex":null,
"mandatory":false,
"type":"NORMAL"
}
]
},
"value":null
}
],
"mappingFiles":null,
"disabled":false
}
},
"serverSideSave":null,
"xmlImportStrategy":"PREFILL",
"bookmarkConfiguration":null,
"processKbName":"Test summary.mplx",
"visualizationConfiguration":null,
"feedback":null,
"uiConfiguration":null
}