public class SystemManagerService
extends java.lang.Object
Constructor and Description |
---|
SystemManagerService() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
addDocument(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String nodeType,
int nodeId,
java.lang.String documentObjJson)
Document is added for the specified nodeId of nodeType.
|
java.lang.String |
addDocumentWithNodeName(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String nodeName,
java.lang.String parentNodeType,
int parentNodeId,
java.lang.String documentObjJson)
Document is added for the specified nodeName, parentNodeId of parentNodeType.
|
java.lang.String |
addIndex(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String jsonSMIndex)
Inserts a new index for the specified SMIndex Object.
|
java.lang.String |
addIndexByColumnId(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int columnId,
java.lang.String jsonSMIndex)
Inserts a new index for the specified columnId and the specified SMIndex
object should contain all the details pertaining to index such as index
name which is mandatory, type,owner etc..
|
java.lang.String |
addIndexes(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String jsonArraySMIndex)
Inserts List of indexes for the specified SMIndex Objects.Each SMIndex
object should contain all the details pertaining to index such as index
name,type,owner etc...where index name is mandatory and SMIndex object
should also contain either column object or list of column objects to
which the index need to be added where in columnId is mandatory in each
column object.
|
java.lang.String |
addIndexesByColumnId(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int columnId,
java.lang.String jsonArraySMIndex)
Inserts list of indexes for the specified columnId where in each SMIndex
object should contain index name.
|
java.lang.String |
assignCodeset(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int columnId,
java.lang.String jsonCodeset)
Assigns the specified codeset to the specified columnId.
|
java.lang.String |
assignCodesets(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int columnId,
java.lang.String jsonArrayCodesetsIds,
boolean unassignExisting)
Assigns codesets of specified codeset ids to the specified columnId.
|
java.lang.String |
assignCodesetsByColumnId(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int columnId,
java.lang.String jsonArrayCodeset)
Assigns the specified list of codesets to the specified columnId.
|
java.lang.String |
cloneEnvironment(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String srcSystemName,
java.lang.String srcEnvironmentName,
java.lang.String tgtSystemName,
java.lang.String tgtEnvironmentName)
Clone Environment creates another copy of the Environment.
|
java.lang.String |
cloneEnvironmentById(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int environmentId,
java.lang.String tgtSystemName,
java.lang.String tgtEnvironmentName)
Clone Environment creates another copy of the Environment.
|
java.lang.String |
cloneEnvironmentBySystemId(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int srcSystemId,
java.lang.String srcEnvironmentName,
int tgtSystemId,
java.lang.String tgtEnvironmentName)
Clone Environment creates another copy of the Environment.
|
java.lang.String |
createColumn(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String smColumnObjJson)
Inserts Column for the specified SMColumn Object.
|
java.lang.String |
createEnvironment(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String smEnvironmentObjJson)
Inserts a new System Environment for the specified environment object.It
creates the environment with the given details.outputFormat can be either
JSON or XML.
|
java.lang.String |
createSystem(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String smSystemObjJson)
Inserts a new system for the specified SMSystem Object.Specifying
systemName is Mandatory.
|
java.lang.String |
createTable(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String smTableObjJson)
Inserts new Table for the specified SMTable Object.
|
java.lang.String |
deleteColumn(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int columnId)
Removes column for the specified columnId.
|
java.lang.String |
deleteDocumentById(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String nodeType,
int docId)
Deletes the Document for the specified docId of nodeType.
|
java.lang.String |
deleteDocuments(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String nodeType,
int nodeId)
Deletes the documents of the specified nodeId of nodeType.
|
java.lang.String |
deleteDocumentsByIds(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String nodeType,
java.lang.String docIdsJsonArray)
Documents are deleted for the specified List of docIds of the given nodeType.
|
java.lang.String |
deleteDocumentsByNodeName(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String nodeName,
java.lang.String parentNodeType,
int parentNodeId)
Documents are deleted for the specified nodeName, parentNodeId of parentNodeType.
|
java.lang.String |
deleteEnvironment(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int environmentId)
Removes System Environment for the specified environmentId.
|
java.lang.String |
deleteEnvironmentDocuments(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int systemId,
java.lang.String environmentName)
Deletes the Environment Documents of the specified environmentName and systemId.
|
java.lang.String |
deleteEnvironmentDocumentsById(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int environmentId)
Deletes the Environment Documents of the specified environmentId.
|
java.lang.String |
deleteIndex(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String jsonSMIndex)
Removes index for the specified SMIndex object.
|
java.lang.String |
deleteIndexById(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int indexId)
Removes SMIndex for the specified indexId.
|
java.lang.String |
deleteIndexes(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String jsonArraySMIndex)
Removes indexes for the specified list of SMIndex objects.
|
java.lang.String |
deleteIndexesByIds(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String jsonArrayIndexId)
Removes indexes for the specified list of index ids.
|
java.lang.String |
deleteIndexesByNode(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String nodeType,
int nodeId)
Removes indexes for the specified nodeId of nodeType.
|
java.lang.String |
deleteSystem(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int systemId)
Removes SMSystem for the specified systemId.It deletes the System only if
it does not contain any Environments or Documents associated with it.
|
java.lang.String |
deleteSystemDocuments(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int systemId)
Deletes the systemDocuments for the specified systemId.
|
java.lang.String |
deleteSystemDocumentsBySystemName(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String systemName)
Deletes the systemDocuments for the specified systemName.
|
java.lang.String |
deleteTable(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int tableId)
Removes the table for the specified tableId.
|
java.lang.String |
exportEnvironment(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int environmentId,
java.lang.String fileExtension)
Environment is exported to xml for the specified environmentId.
|
java.lang.String |
getAssignedCodesets(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int columnId,
int fillOptions)
Returns the list of Codeset objects for the specified columnId.
|
java.lang.String |
getColumn(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int columnId)
Returns SMColumn object for the specified columnId.
|
java.lang.String |
getColumnById(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int columnId,
int fillOptions)
Returns SMColumn object for the specified columnId.
|
java.lang.String |
getColumnByName(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int tableId,
java.lang.String columnName,
int fillOptions)
Returns SMColumn Object for the specified tableId and columnName.
|
java.lang.String |
getColumnId(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int tableId,
java.lang.String columnName)
Returns the columnId for the specified tableId and columnName.
|
java.lang.String |
getColumnIdByBreadcrumb(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String systemName,
java.lang.String environmentName,
java.lang.String tableName,
java.lang.String columnName)
Returns the columnId for the specified environmentName, systemName,
tableName and columnName.
|
java.lang.String |
getColumns(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int tableId)
Returns list of SMColumn Object for the specified tableId.
|
java.lang.String |
getColumnsById(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int tableId,
int fillOptions)
Returns all the associated columns of the particular table as a list of
column objects , for which specifying the tableId and fillOptions
parameters are mandatory in order to retrieve the columns.
|
java.lang.String |
getDocumentById(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String nodeType,
int docId)
Returns the Document object for the specified docId of nodeType.
|
java.lang.String |
getDocumentsByIds(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String nodeType,
java.lang.String docIdsJsonArray)
Returns the List of Document objects for the specified List of docId's of
the nodeType.
|
java.lang.String |
getEnvironment(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int environmentId)
Returns SMEnvironment Object for the specified environmentId.
|
java.lang.String |
getEnvironmentById(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int environmentId,
boolean fillMetadata,
boolean useReferenceId)
Returns SMEnvironment Object for the specified environmentId.Specifying
the environmentId is mandatory.
|
java.lang.String |
getEnvironmentByName(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int systemId,
java.lang.String environmentName)
Returns SMEnvironment Object for the specified systemId and environmentName.
|
java.lang.String |
getEnvironmentConnectionProperties(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String smEnvironmentObjJson)
Returns DBProperties Object for the specified SMEnvironment object.
|
java.lang.String |
getEnvironmentDocuments(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int environmentId)
Returns the List of Document objects for the specified environmentId.
|
java.lang.String |
getEnvironmentId(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int systemId,
java.lang.String environmentName)
Returns the environmentId for the specified systemId and environmentName.
|
java.lang.String |
getEnvironmentIdByName(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String systemName,
java.lang.String environmentName)
Returns the environmentId for the specified systemName and environmentName.
|
java.lang.String |
getEnvironments(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int systemId)
Returns the SMEnvironment Object List for the specified systemId.
|
java.lang.String |
getIndex(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int indexId,
int fillOptions)
Returns SMIndex Object for the specified indexId in the specified
outputFormat.
|
java.lang.String |
getIndexByName(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int tableId,
java.lang.String indexName,
int fillOptions)
Returns SMIndex Object for the specified tableId and indexName.Specifying
the tableId and indexName are mandatory.
|
java.lang.String |
getIndexByNodeByName(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String nodeType,
int nodeId,
java.lang.String indexName,
int fillOptions)
Returns SMIndex object for the specified nodeId of nodeType and
indexName.
|
java.lang.String |
getIndexColumns(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int tableId,
java.lang.String indexName,
int fillOptions)
Returns List of SMColumn objects for the specified tableId of which
columns have the specified indexName as index where each column object
contains details like column name,column datatype,column length and
column precision etc..
|
java.lang.String |
getIndexes(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int tableId,
int fillOptions)
Returns list of SMIndex Objects for the specified tableId.
|
java.lang.String |
getIndexesByNode(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String nodeType,
int nodeId,
int fillOptions)
Returns the list of SMIndex objects for the specified nodeId of nodeType.
|
java.lang.String |
getSystem(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String systemName)
Returns SMSystem Object for the specified systemName and
outputFormat.outputFormat can be either JSON or XML.
|
java.lang.String |
getSystemById(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int systemId)
Returns SMSystem Object for the specified systemId.
|
java.lang.String |
getSystemDocuments(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int systemId)
Returns the list of systemDocuments for the specified systemId and
outputFormat.outputFormat can be either JSON or XML.
|
java.lang.String |
getSystemId(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String systemName)
Returns the systemId for the specified systemName in the given
outputFormat.outputFormat can be either JSON or XML.
|
java.lang.String |
getSystems(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat)
Returns the List of SMSystems in specified outputFormat.outputFormat can
be either JSON or XML.
|
java.lang.String |
getTable(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int tableId,
int fillOptions)
Returns SMTable object for the specified tableId.
|
java.lang.String |
getTableByName(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int environmentId,
java.lang.String tableName)
Returns SMTable object for the specified environmentId and tableName.
|
java.lang.String |
getTableId(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int environmentId,
java.lang.String tableName)
Returns the tableId for the specified environmentId and tableName.
|
java.lang.String |
getTableIdByName(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String systemName,
java.lang.String environmentName,
java.lang.String tableName)
Returns the tableId for the specified systemName, environmentName and
tableName.
|
java.lang.String |
getTables(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int environmentId)
Returns the List of tables for the specified environmentId.
|
java.lang.String |
getValidValues(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int columnId,
int fillOptions)
Returns the List of CodeValue objects for the specified columnId.
|
java.lang.String |
importEnvironment(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int environmentId,
java.lang.String dbHelperObjJson,
java.lang.String dbOperation,
java.lang.String fileExtension)
Imports the environment on the specified environmentId.
|
java.lang.String |
loadEnvironmentMetadata(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String dbHelperObjJson)
Loads an Environment for the specified dbHelper Object.
|
java.lang.String |
loadEnvironmentMetadataById(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int systemId,
java.lang.String environmentName,
boolean useRefrenceId)
Loads the Environment for the specified systemId, environmentName and
useReferenceId.
|
java.lang.String |
publishColumn(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int columnId)
Column is published for the specified columnId.
|
java.lang.String |
publishColumns(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String columnIdsJsonArray)
Columns are published for the specified columnIds, specifying the list of
columnIds are mandatory.
|
java.lang.String |
publishNode(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String nodeType,
int nodeId)
Node is published for the specified nodeId.
|
java.lang.String |
publishNodes(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String nodeType,
java.lang.String nodeIdsJsonArray)
Nodes are published for the specified nodeIds.
|
java.lang.String |
publishTable(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int tableId)
Table is published for the specified tableId.
|
java.lang.String |
publishTables(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String tableIdsJsonArray)
Tables are published for the specified tableIds, specifying the list of
tableIds are mandatory.
|
java.lang.String |
scanEnvironment(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String dbHelperObjJson)
Loads an Environment for the specified dbHelper Object.
|
java.lang.String |
scanIntoEnvironment(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int environmentId,
java.lang.String dbHelperJson,
java.lang.String dbOperation)
Scan and save the environment meta data into the specified environmentId
by specifying the dbHelper object and dbOperation in the form of json.
|
java.lang.String |
unassignExistingCodesets(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String nodeType,
int nodeId)
Unassigns ExistingCodesets for the specified nodeId of nodeType.
|
java.lang.String |
updateColumn(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String smColumnObjJson,
boolean useReferenceId)
Updates the Column for the specified SMColumn Object and useReferenceId.
|
java.lang.String |
updateDocument(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String nodeType,
java.lang.String documentJsonObj)
Document is updated as specified as Document Object of the given nodeType.
|
java.lang.String |
updateEnvironmentDetails(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String smEnvironmentObjJson)
Updates a System Environment for the specified SMEnvironment object.
|
java.lang.String |
updateEnvironmentMetadata(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String dbEnvironmentObjJson,
java.lang.String operation,
boolean useReferenceId)
Saves the environment for the specified DBEnvironment Object,
DBProperties and useReferenceId.
|
java.lang.String |
updateIndex(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String jsonSMIndex)
Updates the index for the specified SMIndex object.
|
java.lang.String |
updateIndexes(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String jsonArraySMIndex)
Updates the List of indexes for the specified SMIndex Objects.
|
java.lang.String |
updateSystem(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String smSystemObjJson)
Updates the system for the specified SMSystem object.i.e when provided
with system details, this method updates the respective information of
the system.
|
java.lang.String |
updateTable(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String smTableObjJson,
boolean useReferenceId)
Updates Table for the specified SMTable Object and useReferenceId.
|
java.lang.String |
versionEnvironment(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
int environmentId,
java.lang.String changeDescription,
java.lang.String versionLabel)
Versions the environment for the specified environmentId.
|
public java.lang.String createSystem(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String smSystemObjJson)
smSystemObjJson
- JSON StringuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XML
Sample 'smSystemObjJson' JSON :
{
"systemName": "",
"systemPrimaryMoveType": "",
"systemDescriptionLong": "",
"fileManagmentSystemType": "",
"serverPlatform": "",
"systemOwnerEmail": "",
"specialInsructionsComments": "",
"esbQManagerName": "",
"endOfDayDefinition": "",
"serverOSVersion": "",
"totalDBSizeInGB": "",
"dbmsPlatform": "",
"dailyBatchExtractWindow": "",
"dbmsVersion": ""
}
public java.lang.String getSystems(java.lang.String userName, java.lang.String password, java.lang.String outputFormat)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLpublic java.lang.String getSystem(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String systemName)
systemName
- StringuserName
- Stringpassword
- StringoutputFormat
- String- Valid values: JSON or XMLpublic java.lang.String getSystemById(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int systemId)
systemId
- intuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLpublic java.lang.String getSystemDocuments(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int systemId)
systemId
- intuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLpublic java.lang.String getSystemId(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String systemName)
systemName
- StringuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLpublic java.lang.String updateSystem(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String smSystemObjJson)
smSystemObjJson
- jsonuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XML
Sample 'smSystemObjJson' JSON :
{
"systemName": "",
"systemId":0,
"systemPrimaryMoveType": "",
"systemDescriptionLong": "",
"fileManagmentSystemType": "",
"serverPlatform": "",
"systemOwnerEmail": "",
"specialInsructionsComments": "",
"esbQManagerName": "",
"endOfDayDefinition": "",
"serverOSVersion": "",
"totalDBSizeInGB": "",
"dbmsPlatform": "",
"dailyBatchExtractWindow": "",
"dbmsVersion": ""
}
public java.lang.String deleteSystem(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int systemId)
systemId
- intuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLpublic java.lang.String createEnvironment(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String smEnvironmentObjJson)
smEnvironmentObjJson
- JSON formatuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XML
Sample 'smEnvironmentObjJson' JSON :
{
"displayViewsInScan": false,
"databaseOptions": null,
"databaseName": "",
"productionSystemName": "",
"workflowStatus": "",
"maximumNoOfConnectionsPerPartition": 5,
"passwordEncrypted": true,
"systemEnvironmentType": "",
"sapClient": "000",
"modelFileName": null,
"databasePoolType": null,
"extendedProperties": null,
"tables": [],
"systemName": "",
"environmentNotes": "",
"draft": 0,
"kerberosPrincipal": null,
"sshPort": 0,
"intendedUseDescription": "",
"rowDelimiter": "\\n",
"visibility": 1,
"productionSystemId": "1",
"noOfPartitions": 2,
"version": "1.00",
"dataFileName": null,
"dataStewardName": "",
"dataProfileScoreId": 0,
"serverPlatform": "",
"versionLabel": "",
"fileManagementSystemType": "",
"schemas": [],
"databaseInstanceSchema": "",
"systemEnvironmentName": "",
"databasePort": "",
"lastLoadingTime": 1554716759883,
"status": "",
"environmentType": "",
"databaseIPAddress": "",
"fieldDelimiter": ",",
"dataStewardChecked": false,
"databaseUserName": "",
"databaseDomain": "",
"environmentId": 0,
"sapScanTables": "",
"systemNumber": "00",
"dataFile": null,
"databaseURL": "",
"systemId": 0,
"sapDestination": null,
"changeDescription": "",
"dataProfileScore": null,
"modelFile": "",
"fileLocation": "",
"productionEnvironmentName": "",
"specialApprovalContvyInstructions": "",
"userId": "",
"displayTablesInScan": true,
"displaySynonymsInScan": false,
"databaseType": "SqlServer",
"minimumNoOfConnectionsPerPartition": 3,
"serverOSVersion": "",
"databasePassword": "",
"databaseDriver": "",
"authenticationType": null,
"systemEnvironmentId": 0
}
public java.lang.String getEnvironments(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int systemId)
systemId
- intuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLpublic java.lang.String getEnvironment(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int environmentId)
environmentId
- intuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLpublic java.lang.String getEnvironmentByName(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int systemId, java.lang.String environmentName)
systemId
- intenvironmentName
- StringuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLpublic java.lang.String getEnvironmentConnectionProperties(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String smEnvironmentObjJson)
smEnvironmentObjJson
- JSON formatuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XML
Sample 'smEnvironmentObjJson' JSON :
{
"displayViewsInScan": false,
"databaseOptions": null,
"databaseName": "",
"productionSystemName": "",
"workflowStatus": "",
"maximumNoOfConnectionsPerPartition": 5,
"passwordEncrypted": true,
"systemEnvironmentType": "",
"sapClient": "000",
"modelFileName": null,
"databasePoolType": null,
"extendedProperties": null,
"tables": [],
"systemName": "",
"environmentNotes": "",
"draft": 0,
"kerberosPrincipal": null,
"sshPort": 0,
"intendedUseDescription": "",
"rowDelimiter": "\\n",
"visibility": 1,
"productionSystemId": "",
"noOfPartitions": 2,
"version": "1.00",
"dataFileName": null,
"dataStewardName": "",
"dataProfileScoreId": 0,
"serverPlatform": "",
"versionLabel": "",
"fileManagementSystemType": "",
"schemas": [],
"databaseInstanceSchema": "",
"systemEnvironmentName": "",
"databasePort": "",
"lastLoadingTime": 1554716759883,
"status": "",
"environmentType": "",
"databaseIPAddress": "",
"fieldDelimiter": ",",
"dataStewardChecked": false,
"databaseUserName": "",
"databaseDomain": "",
"environmentId": 0,
"sapScanTables": "",
"systemNumber": "00",
"dataFile": null,
"databaseURL": "",
"systemId": 0,
"sapDestination": null,
"changeDescription": "",
"dataProfileScore": null,
"modelFile": "",
"fileLocation": "",
"productionEnvironmentName": "",
"specialApprovalContvyInstructions": "",
"userId": "",
"displayTablesInScan": true,
"displaySynonymsInScan": false,
"databaseType": "SqlServer",
"minimumNoOfConnectionsPerPartition": 3,
"serverOSVersion": "",
"databasePassword": "",
"databaseDriver": "",
"authenticationType": null,
"systemEnvironmentId": 0
}
public java.lang.String getEnvironmentId(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int systemId, java.lang.String environmentName)
systemId
- intenvironmentName
- StringuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLpublic java.lang.String getEnvironmentIdByName(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String systemName, java.lang.String environmentName)
systemName
- StringenvironmentName
- StringuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLpublic java.lang.String updateEnvironmentDetails(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String smEnvironmentObjJson)
smEnvironmentObjJson
- JSON formatuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XML
Sample 'smEnvironmentObjJson' JSON :
{
"displayViewsInScan": false,
"databaseOptions": null,
"databaseName": "",
"productionSystemName": "",
"workflowStatus": "",
"maximumNoOfConnectionsPerPartition": 5,
"passwordEncrypted": true,
"systemEnvironmentType": "",
"sapClient": "000",
"modelFileName": null,
"databasePoolType": null,
"extendedProperties": null,
"tables": [],
"systemName": "",
"environmentNotes": "",
"draft": 0,
"kerberosPrincipal": null,
"sshPort": 0,
"intendedUseDescription": "",
"rowDelimiter": "\\n",
"visibility": 1,
"productionSystemId": "",
"noOfPartitions": 2,
"version": "1.00",
"dataFileName": null,
"dataStewardName": "",
"dataProfileScoreId": 0,
"serverPlatform": "",
"versionLabel": "",
"fileManagementSystemType": "",
"schemas": [],
"databaseInstanceSchema": "",
"systemEnvironmentName": "",
"databasePort": "",
"lastLoadingTime": 1554716759883,
"status": "",
"environmentType": "",
"databaseIPAddress": "",
"fieldDelimiter": ",",
"dataStewardChecked": false,
"databaseUserName": "",
"databaseDomain": "",
"environmentId": 0,
"sapScanTables": "",
"systemNumber": "00",
"dataFile": null,
"databaseURL": "",
"systemId": 0,
"sapDestination": null,
"changeDescription": "",
"dataProfileScore": null,
"modelFile": "",
"fileLocation": "",
"productionEnvironmentName": "",
"specialApprovalContvyInstructions": "",
"userId": "",
"displayTablesInScan": true,
"displaySynonymsInScan": false,
"databaseType": "SqlServer",
"minimumNoOfConnectionsPerPartition": 3,
"serverOSVersion": "",
"databasePassword": "",
"databaseDriver": "",
"authenticationType": null,
"systemEnvironmentId": 0
}
public java.lang.String deleteEnvironment(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int environmentId)
environmentId
- intuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLpublic java.lang.String loadEnvironmentMetadata(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String dbHelperObjJson)
DBProperties.DatabaseType
. Depending on this value,
mandatory values will vary from one database to other.
scanCriteria - This defines the selection criteria of
objects(TABLES/VIEWS/SYNONYMS) to be saved into the specified
environment. This takes either INCLUDE_SELECTION or EXCLUDE_SELECTION or
ALL. For values reference at
DBHelper.ScanCriteria
).
If the scanCriteria value is INCLUDE_SELECTION then the only selected
objects are loaded or if the scanCriteria value is EXCLUDE_SELECTION then
apart from selected objects, the rest of the objects from the database
are loaded or if the scanCriteria value is ALL then all the objects in
the database are loaded into environment. Here objects refers to
TABLES/VIEWS/SYNONYMS.
filePath - This property is mandatory when the databaseType is file based
database.
filePathType - The supported values for the filePathType are ABSOLUTE, RELATIVE.
useReferenceId - This property in dbHelper is used only for ERWIN and CWM
file based databases and it accepts boolean value true or false.
erwinModelType & readLogicalColumns - These properties from the dbHelper
object are used for only ERWIN or ERWIN9 file based databases.
erwinModelType defines the order in which the tables are displayed and
readLogicalColumns value defines whether to skip logical columns or not.
The value of erwinModelType value can be either PHYSICAL OR LOGICAL (For
values reference at com.ads.mm.xml.erwin.ERWinBase.ModelType
)).
ERWinBase.ModelType's default value is PHYSICAL.
The value of readLogicalColumns accepts boolean value true or false.
If environment is loaded successfully, DBEnvironment object will be returned in the form of json/xml depending on the output format.
dbHelperObjJson
- in json formatuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XML
Sample 'dbHelperObjJson' JSON :
{
"dbUrl": "jdbc:sqlserver://hostname:1433;databaseName=database_name",
"dbDriver": "com.microsoft.sqlserver.jdbc.SQLServerDriver",
"dbUserName": "username",
"dbPassword": "******",
"dbName": "database name",
"dbSchema": "schema name",
"databaseType": "SQLSERVER",
"scanCriteria": "INCLUDE_SELECTION",
"readColumns": true,
"readComments": false,
"readTables": true,
"readViews": true,
"readSynonyms": true,
"readLogicalColumns": false,
"selectedTables": {
"dbo": [
"ADS_FORM"
]
},
"selectedViews": {},
"selectedSynonyms": {},
"autoCommit": true,
"filePath": "D:\\files to scan\\ERWin\\Demo Model1_10.xml", ==> (for file
based databases)
"filePathType":"ABSOLUTE",
"erwinModelType": "PHYSICAL", ==> (for erwin database)
"useReferenceId": false ==> (for erwin & cwm databases)
}
public java.lang.String loadEnvironmentMetadataById(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int systemId, java.lang.String environmentName, boolean useRefrenceId)
If the useReferenceId is true, the environment is loaded based on checking the table reference id which is set to the tables in the specific environment. If the value is false, the environment gets loaded with out checking the table referenceId which is set to the tables.
systemId
- intenvironmentName
- StringuseRefrenceId
- booleanuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLpublic java.lang.String updateEnvironmentMetadata(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String dbEnvironmentObjJson, java.lang.String operation, boolean useReferenceId)
DBEnvironment Object specifies the options update, insert, validate,
invalidate and skip depending on the databaseType including which it
gives the table count,views count and synonyms count.
DBProperties Object specifies the operation modes in which the
environment will be saved i.e fresh upload, update append and append
modes.
simple append mode is used when environment is save for the first time
i.e add new option.
update append mode is used when previously loaded environment is modified
and few new tables are appended to the environment.
fresh upload mode is used when the previously loaded environment tables
are to be deleted and new tables will be inserted in to the environment.
update append invalidate mode is used when previously loaded meta data is
modified and few new tables needs to appended and few scanned tables need to
be invalidated in the environment.
useReferenceId value is set to true or false depending on the databaseType in which the environment is saved. If environment is saved successfully, RequestStatus.isRequestSuccess() will return true otherwise false.
dbEnvironmentObjJson
- JSON formatoperation
- DBProperties.OperationuseReferenceId
- booleanuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XML
Sample 'dbEnvironmentObjJson' JSON :
{
"environmentName": "",
"system": {
"systemId": 0
},
"schemas": {
"dbo": {
"schemaName": "",
"viewMap": {},
"synonymMap": {},
"tableMap": {
"dbo.table1": {
"tableName": "",
"tableComments": "",
"createdBy": "",
"createdDateTime": 1428994708798,
"lastModifiedBy": "",
"lastModifiedDateTime": 1428994708798,
"tableType": "",
"columnMap": {
"column1": {
"columnName": "",
"datatype": "",
"length": "50",
"precision": "20",
"createdBy": "",
"createdDatetime": 1428994708798,
"lastModifiedBy": "",
"lastModifiedDatetime": 1428994708798,
"scale": "10"
}
}
}
}
}
}
}
public java.lang.String createTable(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String smTableObjJson)
smTableObjJson
- jsonuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XML
Sample 'smTableObjJson' JSON :
{
"expandedLogicalName": "",
"physicalTableName": "",
"workflowStatus": "",
"columns": [],
"actualTableName": null,
"tableComments": null,
"tableAlias": null,
"associatedBusinessTermId": 0,
"schemaName": "",
"declarationPath": "",
"stmid": 0,
"referenceId": null,
"tableName": "",
"tableClass": null,
"valid": true,
"tableType": "",
"extendedProperties": [],
"environmentId": 0,
"logicalTableName": null,
"userDefined10": "",
"parentTable": null,
"marked": false,
"systemId": 0,
"rootTable": true,
"tableDefinition": null,
"columnIndexes": [],
"tableReferenceId": null,
"associatedBusinessTerm": "",
"dataStewardName": null,
"dataProfileScoreId": 0,
"environment": null,
"totalRowsCount": 0,
"userDefined8": "",
"userDefined9": "",
"metadataSource": "",
"userDefined6": "",
"userDefined7": "",
"userDefined4": "",
"userDefined5": "",
"tableId": 0,
"userDefined2": "",
"systemEnvironmentName": "",
"usedInGapAnalysis": true,
"userDefined3": "",
"userDefined1": "",
"fileType": null,
"status": ""
}
public java.lang.String getTable(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int tableId, int fillOptions)
APIConstants.SMFillOptions.TABLE_INDEXES
or APIConstants.SMFillOptions.TABLE_COLUMNS
or APIConstants.SMFillOptions.TABLE_EXTENDED_PROPERTIES
for example: If you want to get Indexes and it's Columns along with SMTable object,
you need to pass the fillOptions parameter value as 3 (TABLE_INDEXES(1) + TABLE_COLUMNS(2)).
tableId
- intfillOptions
- APIConstants.SMFillOptions
intuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLpublic java.lang.String getTableByName(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int environmentId, java.lang.String tableName)
environmentId
- inttableName
- StringuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLpublic java.lang.String getTableId(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int environmentId, java.lang.String tableName)
environmentId
- inttableName
- StringuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLpublic java.lang.String getTableIdByName(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String systemName, java.lang.String environmentName, java.lang.String tableName)
systemName
- StringenvironmentName
- StringtableName
- StringuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLpublic java.lang.String getTables(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int environmentId)
environmentId
- intuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLpublic java.lang.String updateTable(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String smTableObjJson, boolean useReferenceId)
smTableObjJson
- SMTable ObjectuseReferenceId
- booleanuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XML
Sample 'smTableObjJson' JSON :
{
"expandedLogicalName": "",
"physicalTableName": "",
"workflowStatus": "",
"columns": [],
"actualTableName": null,
"tableComments": null,
"tableAlias": null,
"associatedBusinessTermId": 0,
"schemaName": "",
"declarationPath": "",
"stmid": 0,
"referenceId": null,
"tableName": "",
"tableClass": null,
"valid": true,
"tableType": "",
"extendedProperties": [],
"environmentId": 0,
"logicalTableName": null,
"userDefined10": "",
"parentTable": null,
"marked": false,
"systemId": 0,
"rootTable": true,
"tableDefinition": null,
"columnIndexes": [],
"tableReferenceId": null,
"associatedBusinessTerm": "",
"dataStewardName": null,
"dataProfileScoreId": 0,
"environment": null,
"totalRowsCount": 0,
"userDefined8": "",
"userDefined9": "",
"metadataSource": "",
"userDefined6": "",
"userDefined7": "",
"userDefined4": "",
"userDefined5": "",
"tableId": 0,
"userDefined2": "",
"systemEnvironmentName": "",
"usedInGapAnalysis": true,
"userDefined3": "",
"userDefined1": "",
"fileType": null,
"status": ""
}
public java.lang.String deleteTable(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int tableId)
tableId
- intuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLpublic java.lang.String createColumn(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String smColumnObjJson)
smColumnObjJson
- in JSON formatuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XML
Sample 'smColumnObjJson' JSON :
{
"columnLength": "0",
"logicalColumnName": null,
"columnETLDefaultValue": null,
"workflowStatus": "",
"columnDefinition": null,
"associatedBusinessTermId": 0,
"foreignKeyTableName": null,
"validValues": [],
"declarationPath": "",
"columnAlias": null,
"tableName": "",
"minimumValue": null,
"extendedProperties": [],
"userDefined10": "",
"dataProfileEndDate": null,
"dataProfileJobFailReason": null,
"columnScale": "0",
"columnPrecision": "0",
"columnDBDefaultValue": null,
"includeInDataProfile": null,
"columnDatatype": "",
"dataProfileJobState": null,
"stcmid": 0,
"naturalKeyFlag": false,
"physicalColumnName": "",
"dataProfileScoreId": 0,
"dataStewardName": null,
"columnType": "",
"sdiClassificationName": "",
"userDefined8": "",
"userDefined9": "",
"metadataSource": "",
"userDefined6": "",
"userDefined7": "",
"userDefined4": "",
"userDefined5": "",
"userDefined2": "",
"usedInGapAnalysis": true,
"userDefined3": "",
"userDefined1": "",
"sdiFlag": false,
"status": "",
"columnComments": null,
"expandedLogicalName": "",
"businessKeyFlag": false,
"columnId": 0,
"valid": true,
"xpath": null,
"environmentId": 0,
"table": null,
"insertOrder": 1,
"dataProfileScore": null,
"columnIndexes": [],
"sdiDescription": null,
"percentNullValue": null,
"dataProfileStartDate": null,
"columnNullableFlag": true,
"associatedBusinessTerm": "",
"foreignKeyColumnName": null,
"columnDataDomain": null,
"columnIdentityFlag": false,
"foreignKeyFlag": false,
"fileStartingPosition": null,
"columnClass": null,
"tableId": 0,
"storageType": null,
"primaryKeyFlag": false,
"sdiClassificationId": "",
"maximumValue": null,
"columnName": "",
"columnReferenceId": null
}
public java.lang.String getColumn(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int columnId)
columnId
- intuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLpublic java.lang.String getColumnByName(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int tableId, java.lang.String columnName, int fillOptions)
APIConstants.SMFillOptions.COLUMN_INDEXES
or APIConstants.SMFillOptions.COLUMN_EXTENDED_PROPERTIES
or APIConstants.SMFillOptions.COLUMN_VALID_VALUES
or APIConstants.SMFillOptions.VALID_VALUES_EXTENDED_PROPERTIES
.
Based on the value passed its related data is returned within the SMColumn object and
if you want to get column indexes and column extended properties then
fillOptions parameter value will be addition of
COLUMN_INDEXES value and COLUMN_EXTENDED_PROPERTIES value i.e 8+16=24 and so on.
tableId
- intcolumnName
- StringfillOptions
- APIConstants.SMFillOptions
intuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLpublic java.lang.String getColumnId(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int tableId, java.lang.String columnName)
tableId
- intcolumnName
- StringuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLpublic java.lang.String getColumnIdByBreadcrumb(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String systemName, java.lang.String environmentName, java.lang.String tableName, java.lang.String columnName)
systemName
- StringenvironmentName
- StringtableName
- StringcolumnName
- StringuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLpublic java.lang.String getColumns(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int tableId)
tableId
- intuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLpublic java.lang.String updateColumn(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String smColumnObjJson, boolean useReferenceId)
smColumnObjJson
- JSONuseReferenceId
- booleanuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XML
Sample 'smColumnObjJson' JSON :
{
"columnLength": "0",
"logicalColumnName": null,
"columnETLDefaultValue": null,
"workflowStatus": "",
"columnDefinition": null,
"associatedBusinessTermId": 0,
"foreignKeyTableName": null,
"validValues": [],
"declarationPath": "",
"columnAlias": null,
"tableName": "",
"minimumValue": null,
"extendedProperties": [],
"userDefined10": "",
"dataProfileEndDate": null,
"dataProfileJobFailReason": null,
"columnScale": "0",
"columnPrecision": "0",
"columnDBDefaultValue": null,
"includeInDataProfile": null,
"columnDatatype": "",
"dataProfileJobState": null,
"stcmid": 0,
"naturalKeyFlag": false,
"physicalColumnName": "",
"dataProfileScoreId": 0,
"dataStewardName": null,
"columnType": "",
"sdiClassificationName": "",
"userDefined8": "",
"userDefined9": "",
"metadataSource": "",
"userDefined6": "",
"userDefined7": "",
"userDefined4": "",
"userDefined5": "",
"userDefined2": "",
"usedInGapAnalysis": true,
"userDefined3": "",
"userDefined1": "",
"sdiFlag": false,
"status": "",
"columnComments": null,
"expandedLogicalName": "",
"businessKeyFlag": false,
"columnId": 0,
"valid": true,
"xpath": null,
"environmentId": 0,
"table": null,
"insertOrder": 1,
"dataProfileScore": null,
"columnIndexes": [],
"sdiDescription": null,
"percentNullValue": null,
"dataProfileStartDate": null,
"columnNullableFlag": true,
"associatedBusinessTerm": "",
"foreignKeyColumnName": null,
"columnDataDomain": null,
"columnIdentityFlag": false,
"foreignKeyFlag": false,
"fileStartingPosition": null,
"columnClass": null,
"tableId": 0,
"storageType": null,
"primaryKeyFlag": false,
"sdiClassificationId": "",
"maximumValue": null,
"columnName": "",
"columnReferenceId": null
}
public java.lang.String deleteColumn(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int columnId)
columnId
- intuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLpublic java.lang.String addDocument(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String nodeType, int nodeId, java.lang.String documentObjJson)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLnodeType
- Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENTnodeId
- intdocumentObjJson
- String Document Object.
Sample 'documentObjJson' JSON :
{
"documentIntendedPurpose": "",
"userData": null,
"documentReferenceNumber": "",
"documentType": "",
"documentName": "",
"documentApprovedBy": "",
"documentObject": "",
"approvalRequired": false,
"documentOwner": "",
"documentLink": "",
"documentId": 0,
"documentReference": "",
"documentStatus": "",
"documentApprovedDate": 1460701213000
}
public java.lang.String addDocumentWithNodeName(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String nodeName, java.lang.String parentNodeType, int parentNodeId, java.lang.String documentObjJson)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLnodeName
- StringparentNodeType
- Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENTparentNodeId
- intdocumentObjJson
- String Document Object.
Sample 'documentObjJson' JSON :
{
"documentIntendedPurpose": "",
"userData": null,
"documentReferenceNumber": "",
"documentType": "",
"documentName": "",
"documentApprovedBy": "",
"documentObject": "",
"approvalRequired": false,
"documentOwner": "",
"documentLink": "",
"documentId": 0,
"documentReference": "",
"documentStatus": "",
"documentApprovedDate": 1460701213000
}
public java.lang.String deleteDocuments(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String nodeType, int nodeId)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLnodeType
- Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENTnodeId
- intpublic java.lang.String deleteDocumentsByNodeName(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String nodeName, java.lang.String parentNodeType, int parentNodeId)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLnodeName
- StringparentNodeType
- Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENTparentNodeId
- intpublic java.lang.String deleteSystemDocuments(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int systemId)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLsystemId
- intpublic java.lang.String deleteSystemDocumentsBySystemName(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String systemName)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLsystemName
- Stringpublic java.lang.String deleteEnvironmentDocumentsById(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int environmentId)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLenvironmentId
- intpublic java.lang.String deleteEnvironmentDocuments(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int systemId, java.lang.String environmentName)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLsystemId
- intenvironmentName
- Stringpublic java.lang.String deleteDocumentById(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String nodeType, int docId)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLnodeType
- Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENTdocId
- intpublic java.lang.String getDocumentById(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String nodeType, int docId)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLnodeType
- Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENTdocId
- intpublic java.lang.String getDocumentsByIds(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String nodeType, java.lang.String docIdsJsonArray)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLnodeType
- Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENTdocIdsJsonArray
- Listpublic java.lang.String getEnvironmentDocuments(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int environmentId)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLenvironmentId
- intpublic java.lang.String deleteDocumentsByIds(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String nodeType, java.lang.String docIdsJsonArray)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLnodeType
- Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENTdocIdsJsonArray
- Listpublic java.lang.String updateDocument(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String nodeType, java.lang.String documentJsonObj)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLnodeType
- Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENTdocumentJsonObj
- String - Document Object
Sample 'documentJsonObj' JSON :
{
"documentIntendedPurpose": "",
"userData": null,
"documentReferenceNumber": "",
"documentType": "",
"documentName": "",
"documentApprovedBy": "",
"documentObject": "",
"approvalRequired": false,
"documentOwner": "",
"documentLink": "",
"documentId": 0,
"documentReference": "",
"documentStatus": "",
"documentApprovedDate": 1460701213000
}
public java.lang.String cloneEnvironment(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String srcSystemName, java.lang.String srcEnvironmentName, java.lang.String tgtSystemName, java.lang.String tgtEnvironmentName)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLsrcSystemName
- StringsrcEnvironmentName
- StringtgtSystemName
- StringtgtEnvironmentName
- Stringpublic java.lang.String cloneEnvironmentBySystemId(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int srcSystemId, java.lang.String srcEnvironmentName, int tgtSystemId, java.lang.String tgtEnvironmentName)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLsrcSystemId
- intsrcEnvironmentName
- StringtgtSystemId
- inttgtEnvironmentName
- Stringpublic java.lang.String cloneEnvironmentById(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int environmentId, java.lang.String tgtSystemName, java.lang.String tgtEnvironmentName)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLenvironmentId
- inttgtSystemName
- StringtgtEnvironmentName
- Stringpublic java.lang.String getEnvironmentById(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int environmentId, boolean fillMetadata, boolean useReferenceId)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLenvironmentId
- IntegerfillMetadata
- booleanuseReferenceId
- booleanpublic java.lang.String getColumnById(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int columnId, int fillOptions)
APIConstants.SMFillOptions
.
APIConstants.SMFillOptions.COLUMN_INDEXES
or APIConstants.SMFillOptions.COLUMN_EXTENDED_PROPERTIES
or APIConstants.SMFillOptions.COLUMN_VALID_VALUES
or APIConstants.SMFillOptions.VALID_VALUES_EXTENDED_PROPERTIES
.
Based on the value passed its related data is returned within the SMColumn object and
if you want to get column indexes and column extended properties then
fillOptions parameter value will be addition of
COLUMN_INDEXES value and COLUMN_EXTENDED_PROPERTIES value i.e 8+16=24 and so on.
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLcolumnId
- intfillOptions
- APIConstants.SMFillOptions
intpublic java.lang.String getColumnsById(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int tableId, int fillOptions)
APIConstants.SMFillOptions
.
APIConstants.SMFillOptions.COLUMN_INDEXES
or APIConstants.SMFillOptions.COLUMN_EXTENDED_PROPERTIES
or APIConstants.SMFillOptions.COLUMN_VALID_VALUES
or APIConstants.SMFillOptions.VALID_VALUES_EXTENDED_PROPERTIES
.
Based on the value passed its related data is returned within the SMColumn object and
if you want to get column indexes and column extended properties then
fillOptions parameter value will be addition of
COLUMN_INDEXES value and COLUMN_EXTENDED_PROPERTIES value i.e 8+16=24 and so on.
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLtableId
- intfillOptions{@link
- com.ads.api.beans.common.APIConstants.SMFillOptions} intpublic java.lang.String getIndexColumns(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int tableId, java.lang.String indexName, int fillOptions)
APIConstants.SMFillOptions
.
APIConstants.SMFillOptions.COLUMN_INDEXES
or APIConstants.SMFillOptions.COLUMN_EXTENDED_PROPERTIES
or APIConstants.SMFillOptions.COLUMN_VALID_VALUES
or APIConstants.SMFillOptions.VALID_VALUES_EXTENDED_PROPERTIES
.
Based on the value passed its related data is returned within the SMColumn object and
if you want to get column indexes and column extended properties then
fillOptions parameter value will be addition of
COLUMN_INDEXES value and COLUMN_EXTENDED_PROPERTIES value i.e 8+16=24 and so on.
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLtableId
- intindexName
- StringfillOptions
- APIConstants.SMFillOptions
intpublic java.lang.String addIndex(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String jsonSMIndex)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLjsonSMIndex
- JSON String
Sample 'jsonSMIndex' JSON :
{
"id":0,
"tableId":0,
"name": "",
"owner": "",
"uniqueness": "",
"sortOrder": "",
"type": "",
"ordinalPosition": 0,
"columns": [
{
"columnId": 0
}
]
}
public java.lang.String addIndexByColumnId(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int columnId, java.lang.String jsonSMIndex)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLcolumnId
- intjsonSMIndex
- String
Sample 'jsonSMIndex' JSON :
{
"id":0,
"tableId":0,
"name": "",
"owner": "",
"uniqueness": "",
"sortOrder": "",
"type": "",
"ordinalPosition": 0,
"columns": [
{
"columnId": 0
}
]
}
public java.lang.String addIndexes(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String jsonArraySMIndex)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLjsonArraySMIndex
- String - smIndex Object list
Sample 'jsonArraySMIndex' JSON :
[
{
"id":0,
"tableId":0,
"name": "",
"owner": "",
"uniqueness": "",
"sortOrder": "",
"type": "test",
"ordinalPosition": 0,
"columns": [
{
"columnId": 0
}
]
},
{
"id":0,
"tableId":0,
"name": "",
"owner": "",
"uniqueness": "",
"sortOrder": "",
"type": "",
"ordinalPosition": 0,
"columns": [
{
"columnId": 0
}
]
}
]
public java.lang.String addIndexesByColumnId(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int columnId, java.lang.String jsonArraySMIndex)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLcolumnId
- intjsonArraySMIndex
- String
Sample 'jsonArraySMIndex' JSON :
[
{
"id":0,
"tableId":0,
"name": "",
"owner": "",
"uniqueness": "",
"sortOrder": "",
"type": "",
"ordinalPosition": 0,
},
{
"id":0,
"tableId":0,
"name": "",
"owner": "",
"uniqueness": "",
"sortOrder": "",
"type": "",
"ordinalPosition": 0,
}
]
public java.lang.String updateIndex(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String jsonSMIndex)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLjsonSMIndex
- String - smIndex Object
Sample 'jsonSMIndex' JSON :
{
"id":0,
"tableId":0,
"name": "",
"owner": "",
"uniqueness": "",
"sortOrder": "",
"type": "",
"ordinalPosition": 0,
"columns": [
{
"columnId": 0
}
]
}
public java.lang.String updateIndexes(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String jsonArraySMIndex)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLjsonArraySMIndex
- String - smIndex objects list
Sample 'jsonArraySMIndex' JSON :
[
{
"id":0,
"tableId":0,
"name": "",
"owner": "",
"uniqueness": "",
"sortOrder": "",
"type": "",
"ordinalPosition": 0,
"columns": [
{
"columnId": 0
}
]
},
{
"id":0,
"tableId":0,
"name": "",
"owner": "",
"uniqueness": "",
"sortOrder": "",
"type": "",
"ordinalPosition": 0,
"columns": [
{
"columnId": 0
}
]
}
]
public java.lang.String deleteIndexById(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int indexId)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLindexId
- intpublic java.lang.String deleteIndex(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String jsonSMIndex)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLjsonSMIndex
- String - smIndex Object
Sample 'jsonSMIndex' JSON :
{
"id":0,
"tableId":0,
"name": "",
"owner": "",
"uniqueness": "",
"sortOrder": "",
"type": "",
"ordinalPosition": 0
}
public java.lang.String deleteIndexesByIds(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String jsonArrayIndexId)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLjsonArrayIndexId
- Stringpublic java.lang.String deleteIndexes(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String jsonArraySMIndex)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLjsonArraySMIndex
- String
Sample 'jsonArraySMIndex' JSON :
[
{
"id":0,
"tableId":0,
"name": "",
"owner": "",
"uniqueness": "",
"sortOrder": "",
"type": "",
"ordinalPosition": 0,
"columns": [
{
"columnId": 0
}
]
},
{
"id":0,
"tableId":0,
"name": "",
"owner": "",
"uniqueness": "",
"sortOrder": "",
"type": "",
"ordinalPosition": 0,
"columns": [
{
"columnId": 0
}
]
}
]
public java.lang.String deleteIndexesByNode(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String nodeType, int nodeId)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLnodeType
- Node Object - valid types - SM_TABLE, SM_COLUMNnodeId
- intpublic java.lang.String getIndex(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int indexId, int fillOptions)
APIConstants.SMFillOptions
.
APIConstants.SMFillOptions.INDEX_COLUMN_ASSOCIATES
Based on the value passed its related data is returned within the
SMIndex object. For example if you want to get associated column objects
of the index ,then fillOptions parameter value will be
INDEX_COLUMN_ASSOCIATES value i.e 128.
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLindexId
- intfillOptions
- APIConstants.SMFillOptions
intpublic java.lang.String getIndexByName(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int tableId, java.lang.String indexName, int fillOptions)
APIConstants.SMFillOptions
.
APIConstants.SMFillOptions.INDEX_COLUMN_ASSOCIATES
Based on the value passed its related data is returned within the
SMIndex object. For example if you want to get associated column objects
of the index,then fillOptions parameter value will be
INDEX_COLUMN_ASSOCIATES value i.e 128.
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLtableId
- intindexName
- StringfillOptions
- APIConstants.SMFillOptions
intpublic java.lang.String getIndexes(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int tableId, int fillOptions)
APIConstants.SMFillOptions
.
APIConstants.SMFillOptions.INDEX_COLUMN_ASSOCIATES
Based on the value passed its related data is returned within the
SMIndex object. For example if you want to get associated column objects
of the index,then fillOptions parameter value will be
INDEX_COLUMN_ASSOCIATES value i.e 128.
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLtableId
- intfillOptions
- APIConstants.SMFillOptions
intpublic java.lang.String getIndexesByNode(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String nodeType, int nodeId, int fillOptions)
APIConstants.SMFillOptions
.
APIConstants.SMFillOptions.INDEX_COLUMN_ASSOCIATES
Based on the value passed its related data is returned within the
SMIndex object. For example if you want to get associated column objects
of the index,then fillOptions
parameter value will be INDEX_COLUMN_ASSOCIATES value i.e 128.
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLnodeType
- Node Object - valid types - SM_TABLE, SM_COLUMNnodeId
- intfillOptions
- APIConstants.SMFillOptions
intpublic java.lang.String getIndexByNodeByName(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String nodeType, int nodeId, java.lang.String indexName, int fillOptions)
APIConstants.SMFillOptions
.
APIConstants.SMFillOptions.INDEX_COLUMN_ASSOCIATES
Based on the value passed its related data is returned within the
SMIndex object. For example if you want to get associated column objects
of the index,then fillOptions
parameter value will be INDEX_COLUMN_ASSOCIATES value i.e 128.
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLnodeType
- Node Object - valid types - SM_TABLE, SM_COLUMNnodeId
- intindexName
- StringfillOptions
- APIConstants.SMFillOptions
intpublic java.lang.String getAssignedCodesets(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int columnId, int fillOptions)
APIConstants.SMFillOptions
.
com.ads.api.beans.common.APIConstants.SMFillOptions#CODE_VALUES
or com.ads.api.beans.common.APIConstants.SMFillOptions#CODE_VALUE_EXTENDED_PROPERTIES
Based on the value passed its related data is returned within the Codeset object and
if you want to get codeValues and codeValue extended properties then
fillOptions parameter value will be addition of
CODE_VALUES value and CODE_VALUE_EXTENDED_PROPERTIES value i.e 32+64=96 and so on.
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLcolumnId
- intfillOptions
- APIConstants.CSMFillOptions
intpublic java.lang.String getValidValues(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int columnId, int fillOptions)
APIConstants.SMFillOptions
.
com.ads.api.beans.common.APIConstants.SMFillOptions#CODE_VALUE_EXTENDED_PROPERTIES
whose value is 64.
If fillOptions parameter value is passed as 64 then codeValue's
extended properties are returned within the
CodeValue object.
If CodeValue's extended properties are not required then pass 0(zero)
which is default value for fillOptions.
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLcolumnId
- intfillOptions
- APIConstants.SMFillOptions
intpublic java.lang.String assignCodeset(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int columnId, java.lang.String jsonCodeset)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLcolumnId
- intjsonCodeset
- String
Sample 'jsonCodeset' 'JSON :
{
"changedDescription": "",
"releaseFlag": false,
"codeValues": [],
"description": " ",
"published": false,
"version": 0,
"versionLabel": "",
"lockedBy": "",
"name": "",
"id": 0,
"publishEnvironments": [],
"categoryId": 0,
"status": ""
}
public java.lang.String assignCodesetsByColumnId(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int columnId, java.lang.String jsonArrayCodeset)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLcolumnId
- intjsonArrayCodeset
- String
Sample 'jsonArrayCodeset' JSON :
[
{
"changedDescription": "",
"releaseFlag": false,
"codeValues": [],
"description": " ",
"published": false,
"version": 0,
"versionLabel": "",
"lockedBy": "",
"name": "",
"id": 0,
"publishEnvironments": [],
"categoryId": 0,
"status": ""
},
{
"changedDescription": "",
"releaseFlag": false,
"codeValues": [],
"description": " ",
"published": false,
"version": 0,
"versionLabel": "",
"lockedBy": "",
"name": "",
"id": 0,
"publishEnvironments": [],
"categoryId": 0,
"status": ""
}
]
public java.lang.String assignCodesets(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int columnId, java.lang.String jsonArrayCodesetsIds, boolean unassignExisting)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLcolumnId
- intjsonArrayCodesetsIds
- StringunassignExisting
- boolean
Sample 'jsonArrayCodesetsIds' JSON :
[1,2,3]
public java.lang.String unassignExistingCodesets(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String nodeType, int nodeId)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLnodeType
- StringnodeId
- intpublic java.lang.String publishTable(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int tableId)
userName
- Stringpassword
- StringoutputFormat
- String- Valid values: JSON or XMLtableId
- intpublic java.lang.String publishColumn(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int columnId)
userName
- Stringpassword
- StringoutputFormat
- String- Valid values: JSON or XMLcolumnId
- intpublic java.lang.String publishNode(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String nodeType, int nodeId)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLnodeId
- intnodeType
- String - valid Types are SM_TABLE, SM_COLUMNpublic java.lang.String publishTables(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String tableIdsJsonArray)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLtableIdsJsonArray
- String - List of tableIdspublic java.lang.String publishColumns(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String columnIdsJsonArray)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLcolumnIdsJsonArray
- String - List of columnIdspublic java.lang.String publishNodes(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String nodeType, java.lang.String nodeIdsJsonArray)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLnodeType
- String - Valid types: SM_TABLE, SM_COLUMNnodeIdsJsonArray
- String - List of nodeIdspublic java.lang.String scanIntoEnvironment(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int environmentId, java.lang.String dbHelperJson, java.lang.String dbOperation)
DBProperties.DatabaseType
. Depending on this value,
mandatory values will vary from one database to other.
scanCriteria - This defines the selection criteria of
objects(TABLES/VIEWS/SYNONYMS) to be saved into the specified
environment. This takes either INCLUDE_SELECTION or EXCLUDE_SELECTION or
ALL. For values reference at
DBHelper.ScanCriteria
).
If the scanCriteria value is INCLUDE_SELECTION then the only selected
objects are loaded and persisted or if the scanCriteria value is
EXCLUDE_SELECTION then apart from selected objects, the rest of the
objects from the database are loaded and persisted or if the scanCriteria
value is ALL then all the objects in the database are loaded and
persisted into specified environment. Here objects refers to
TABLES/VIEWS/SYNONYMS.
filePath - This property is mandatory when the databaseType is file based
database.
filePathType - The supported values for the filePathType are ABSOLUTE, RELATIVE.
useReferenceId - This property in dbHelper is used only for ERWIN and CWM
file based databases and it accepts boolean value true or false.
erwinModelType & readLogicalColumns - These properties from the dbHelper
object are used for only ERWIN or ERWIN9 file based databases.
erwinModelType defines the order in which the tables are displayed and
readLogicalColumns value defines whether to skip logical columns or not.
The value of erwinModelType value can be either PHYSICAL OR LOGICAL (For
values reference at com.ads.mm.xml.erwin.ERWinBase.ModelType
)).
ERWinBase.ModelType's default value is PHYSICAL.
The value of readLogicalColumns accepts boolean value true or false.
dbOperation - DBProperties Object specifies the operation modes in
which the environment will be saved i.e fresh upload, update append and
append modes(for values reference
DBProperties.Operation
).
Simple append mode is used when environment is saved for the first time
i.e add new option.
Update append mode is used when previously loaded environment is modified
and few new tables are appended to the environment.
Fresh upload mode is used when the previously loaded environment tables
are to be deleted and new tables will be inserted in to the environment.
update append invalidate mode is used when previously loaded meta data is
modified and few new tables needs to appended and few scanned tables need to
be invalidated in the environment.
If environment is saved successfully, RequestStatus.isRequestSuccess() will return true otherwise false.
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLenvironmentId
- intdbHelperJson
- in json formatdbOperation
- String
Sample 'dbHelperJson' JSON :
{
"dbUrl": "jdbc:sqlserver://hostname:1433;databaseName=database_name",
"dbDriver": "com.microsoft.sqlserver.jdbc.SQLServerDriver",
"dbUserName": "user name",
"dbPassword": "******",
"dbName": "database name",
"dbSchema": "schema name",
"databaseType": "SQLSERVER",
"scanCriteria": "INCLUDE_SELECTION",
"readColumns": true,
"readComments": false,
"readTables": true,
"readViews": true,
"readSynonyms": true,
"readLogicalColumns": false,
"selectedTables": {
"dbo": [
"ADS_FORM"
]
},
"selectedViews": {},
"selectedSynonyms": {},
"autoCommit": true,
"filePath": "D:\\files to scan\\ERWin\\Demo Model1_10.xml", ==> (for file
based databases)
"filePathType":"ABSOLUTE",
"erwinModelType": "PHYSICAL", ==> (for erwin database)
"useReferenceId": false ==> (for erwin & cwm databases)
}
public java.lang.String scanEnvironment(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String dbHelperObjJson)
DBProperties.DatabaseType
. Depending on this value,
mandatory values will vary from one database to other.
scanCriteria - This defines the selection criteria of
objects(TABLES/VIEWS/SYNONYMS) to be saved into the specified
environment. This takes either INCLUDE_SELECTION or EXCLUDE_SELECTION or
ALL. For values reference at
DBHelper.ScanCriteria
).
If the scanCriteria value is INCLUDE_SELECTION then the only selected
objects are loaded or if the scanCriteria value is EXCLUDE_SELECTION then
apart from selected objects, the rest of the objects from the database
are loaded or if the scanCriteria value is ALL then all the objects in
the database are loaded into environment. Here objects refers to
TABLES/VIEWS/SYNONYMS.
filePath - This property is mandatory when the databaseType is file based
database.
filePathType - The supported values for the filePathType are ABSOLUTE, RELATIVE.
useReferenceId - This property in dbHelper is used only for ERWIN and CWM
file based databases and it accepts boolean value true or false.
erwinModelType & readLogicalColumns - These properties from the dbHelper
object are used for only ERWIN or ERWIN9 file based databases.
erwinModelType defines the order in which the tables are displayed and
readLogicalColumns value defines whether to skip logical columns or not.
The value of erwinModelType value can be either PHYSICAL OR LOGICAL (For
values reference at com.ads.mm.xml.erwin.ERWinBase.ModelType
)).
ERWinBase.ModelType's default value is PHYSICAL.
The value of readLogicalColumns accepts boolean value true or false.
If environment is loaded successfully, DBEnvironment object will be returned in the form of json/xml depending on the output format.
dbHelperObjJson
- in json formatuserName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XML
Sample 'dbHelperObjJson' JSON :
{
"dbUrl": "jdbc:sqlserver://hostname:1433;databaseName=database_name",
"dbDriver": "com.microsoft.sqlserver.jdbc.SQLServerDriver",
"dbUserName": "user name",
"dbPassword": "******",
"dbName": "database name",
"dbSchema": "schema name",
"databaseType": "SQLSERVER",
"scanCriteria": "INCLUDE_SELECTION",
"readColumns": true,
"readComments": false,
"readTables": true,
"readViews": true,
"readSynonyms": true,
"readLogicalColumns": false,
"selectedTables": {
"dbo": [
"ADS_FORM"
]
},
"selectedViews": {},
"selectedSynonyms": {},
"autoCommit": true,
"filePath": "D:\\files to scan\\ERWin\\Demo Model1_10.xml", ==> (for file
based databases)
"filePathType":"ABSOLUTE",
"erwinModelType": "PHYSICAL", ==> (for erwin database)
"useReferenceId": false ==> (for erwin & cwm databases)
}
public java.lang.String importEnvironment(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int environmentId, java.lang.String dbHelperObjJson, java.lang.String dbOperation, java.lang.String fileExtension)
DBProperties.Operation
).
userName
- - Stringpassword
- - StringenvironmentId
- - intdbHelperObjJson
- - String in json formatdbOperation
- - StringfileExtension
- - String - Valid Types XML, AMP, ZIP.outputFormat
- String - Valid values: JSON or XMLpublic java.lang.String exportEnvironment(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int environmentId, java.lang.String fileExtension)
userName
- - Stringpassword
- - StringoutputFormat
- String - Valid values: JSON or XMLenvironmentId
- - intfileExtension
- String - Valid Types XML, AMP, ZIP.public java.lang.String versionEnvironment(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, int environmentId, java.lang.String changeDescription, java.lang.String versionLabel)
userName
- - Stringpassword
- - StringenvironmentId
- - intchangeDescription
- - StringversionLabel
- - StringoutputFormat
- String - Valid values: JSON or XML