com.ads.services.webservice.SystemManagerService

public class SystemManagerService extends Object

Contains the methods which performs the operations like Creation, Update, Deletion and Retrieval of Systems, Environments, Tables, and Columns.
All the WebServices methods have return type String - meaning if the method is execution is successful, then it will return a string in the form of JSON or XML String based on the outputFormat parameter given by the user.

Constructor Summary

Constructors

Constructor

Description

SystemManagerService()
Method Summary

Modifier and Type

Method

Description

String

addDocument(String userName, String password, String outputFormat, String nodeType, int nodeId, String documentObjJson)

Document is added for the specified nodeId of nodeType.

String

addDocumentWithNodeName(String userName, String password, String outputFormat, String nodeName, String parentNodeType, int parentNodeId, String documentObjJson)

Document is added for the specified nodeName, parentNodeId of parentNodeType.

String

addIndex(String userName, String password, String outputFormat, String jsonSMIndex)

Inserts a new index for the specified SMIndex Object.

String

addIndexByColumnId(String userName, String password, String outputFormat, int columnId, 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..

String

addIndexes(String userName, String password, String outputFormat, 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.

String

addIndexesByColumnId(String userName, String password, String outputFormat, int columnId, String jsonArraySMIndex)

Inserts list of indexes for the specified columnId where in each SMIndex object should contain index name.

String

addSDIClassifications(String userName, String password, String outputFormat, String nodeType, String objectIdsListOfSDIClassificationsJson)

This function is used to insert a list of SDI classifications for the specified nodeType.

String

cloneEnvironment(String userName, String password, String outputFormat, String srcSystemName, String srcEnvironmentName, String tgtSystemName, String tgtEnvironmentName)

Clone Environment creates another copy of the Environment.

String

cloneEnvironmentById(String userName, String password, String outputFormat, int environmentId, String tgtSystemName, String tgtEnvironmentName)

Clone Environment creates another copy of the Environment.

String

cloneEnvironmentBySystemId(String userName, String password, String outputFormat, int srcSystemId, String srcEnvironmentName, int tgtSystemId, String tgtEnvironmentName)

Clone Environment creates another copy of the Environment.

String

createColumn(String userName, String password, String outputFormat, String smColumnObjJson)

Inserts Column for the specified SMColumn Object.

String

createEnvironment(String userName, String password, String outputFormat, 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.

String

createSystem(String userName, String password, String outputFormat, String smSystemObjJson)

Inserts a new system for the specified SMSystem Object.Specifying systemName is Mandatory.

String

createTable(String userName, String password, String outputFormat, String smTableObjJson)

Inserts new Table for the specified SMTable Object.

String

deleteColumn(String userName, String password, String outputFormat, int columnId)

Removes column for the specified columnId.

String

deleteDocumentById(String userName, String password, String outputFormat, String nodeType, int docId)

Deletes the Document for the specified docId of nodeType.

String

deleteDocuments(String userName, String password, String outputFormat, String nodeType, int nodeId)

Deletes the documents of the specified nodeId of nodeType.

String

deleteDocumentsByIds(String userName, String password, String outputFormat, String nodeType, String docIdsJsonArray)

Documents are deleted for the specified List of docIds of the given nodeType.

String

deleteDocumentsByNodeName(String userName, String password, String outputFormat, String nodeName, String parentNodeType, int parentNodeId)

Documents are deleted for the specified nodeName, parentNodeId of parentNodeType.

String

deleteEnvironment(String userName, String password, String outputFormat, int environmentId)

Removes System Environment for the specified environmentId.

String

deleteEnvironmentById(String userName, String password, String outputFormat, int environmentId, String versionMode)

Deletes the environment with the specified environmentId and versionMode.

String

deleteEnvironmentDocuments(String userName, String password, String outputFormat, int systemId, String environmentName)

Deletes the Environment Documents of the specified environmentName and systemId.

String

deleteEnvironmentDocumentsById(String userName, String password, String outputFormat, int environmentId)

Deletes the Environment Documents of the specified environmentId.

String

deleteIndex(String userName, String password, String outputFormat, String jsonSMIndex)

Removes index for the specified SMIndex object.

String

deleteIndexById(String userName, String password, String outputFormat, int indexId)

Removes SMIndex for the specified indexId.

String

deleteIndexes(String userName, String password, String outputFormat, String jsonArraySMIndex)

Removes indexes for the specified list of SMIndex objects.

String

deleteIndexesByIds(String userName, String password, String outputFormat, String jsonArrayIndexId)

Removes indexes for the specified list of index ids.

String

deleteIndexesByNode(String userName, String password, String outputFormat, String nodeType, int nodeId)

Removes indexes for the specified nodeId of nodeType.

String

deleteSystem(String userName, String password, 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.

String

deleteSystemDocuments(String userName, String password, String outputFormat, int systemId)

Deletes the systemDocuments for the specified systemId.

String

deleteSystemDocumentsBySystemName(String userName, String password, String outputFormat, String systemName)

Deletes the systemDocuments for the specified systemName.

String

deleteTable(String userName, String password, String outputFormat, int tableId)

Removes the table for the specified tableId.

String

deleteTables(String userName, String password, String outputFormat, String tableIdsJsonArray)

Deletes the tables with the specified list of tableIds.

String

deleteTablesByEnvironmentId(String userName, String password, String outputFormat, int environmentId)

Deletes the list of tables for the given environmentId.

String

exportDataDictionary(String userName, String password, String outputFormat, int objectId, int objectTypeId, int fillOptions)

Environment or table is exported to xlsx format for the specified objectId and objectTypeId.

String

exportEnvironment(String userName, String password, String outputFormat, int environmentId, String fileExtension)

Environment is exported to xml for the specified environmentId.

String

getColumn(String userName, String password, String outputFormat, int columnId)

Returns SMColumn object for the specified columnId.

String

getColumnById(String userName, String password, String outputFormat, int columnId, int fillOptions)

Returns SMColumn object for the specified columnId.

String

getColumnByName(String userName, String password, String outputFormat, int tableId, String columnName, int fillOptions)

Returns SMColumn Object for the specified tableId and columnName.

String

getColumnId(String userName, String password, String outputFormat, int tableId, String columnName)

Returns the columnId for the specified tableId and columnName.

String

getColumnIdByBreadcrumb(String userName, String password, String outputFormat, String systemName, String environmentName, String tableName, String columnName)

Returns the columnId for the specified environmentName, systemName, tableName and columnName.

String

getColumns(String userName, String password, String outputFormat, int tableId)

Returns list of SMColumn Object for the specified tableId.

String

getColumnsById(String userName, String password, 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.

String

getColumnsWithFillOptions(String userName, String password, String outputFormat, String columnIds, int fillOptions)

Returns the list of SMColumn objects for the specified list of columnIds along with fillOptions value.

String

getDocumentById(String userName, String password, String outputFormat, String nodeType, int docId)

Returns the Document object for the specified docId of nodeType.

String

getDocumentsByIds(String userName, String password, String outputFormat, String nodeType, String docIdsJsonArray)

Returns the List of Document objects for the specified List of docId's of the nodeType.

String

getEnvironment(String userName, String password, String outputFormat, int environmentId)

Returns SMEnvironment Object for the specified environmentId.

String

getEnvironmentById(String userName, String password, String outputFormat, int environmentId, boolean fillMetadata, boolean useReferenceId)

Returns SMEnvironment Object for the specified environmentId.Specifying the environmentId is mandatory.

String

getEnvironmentByName(String userName, String password, String outputFormat, int systemId, String environmentName)

Returns SMEnvironment Object for the specified systemId and environmentName.

String

getEnvironmentConnectionProperties(String userName, String password, String outputFormat, String smEnvironmentObjJson)

Returns DBProperties Object for the specified SMEnvironment object.

String

getEnvironmentDocuments(String userName, String password, String outputFormat, int environmentId)

Returns the List of Document objects for the specified environmentId.

String

getEnvironmentId(String userName, String password, String outputFormat, int systemId, String environmentName)

Returns the environmentId for the specified systemId and environmentName.

String

getEnvironmentIdByName(String userName, String password, String outputFormat, String systemName, String environmentName)

Returns the environmentId for the specified systemName and environmentName.

String

getEnvironments(String userName, String password, String outputFormat, int systemId)

Returns the SMEnvironment Object List for the specified systemId.

String

getEnvironmentWithFillOptions(String userName, String password, String outputFormat, int environmentId, int fillOptions, boolean useReferenceId)

Returns SMEnvironment object for the specified environmentId, fillOptions, and useReferenceId.

String

getIndex(String userName, String password, String outputFormat, int indexId, int fillOptions)

Returns SMIndex Object for the specified indexId in the specified outputFormat.

String

getIndexByName(String userName, String password, String outputFormat, int tableId, String indexName, int fillOptions)

Returns SMIndex Object for the specified tableId and indexName.Specifying the tableId and indexName are mandatory.

String

getIndexByNodeByName(String userName, String password, String outputFormat, String nodeType, int nodeId, String indexName, int fillOptions)

Returns SMIndex object for the specified nodeId of nodeType and indexName.

String

getIndexColumns(String userName, String password, String outputFormat, int tableId, 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..

String

getIndexes(String userName, String password, String outputFormat, int tableId, int fillOptions)

Returns list of SMIndex Objects for the specified tableId.

String

getIndexesByNode(String userName, String password, String outputFormat, String nodeType, int nodeId, int fillOptions)

Returns the list of SMIndex objects for the specified nodeId of nodeType.

String

getMetaData(String userName, String password, String outputFormat, String inputJson)

Returns the metadata information includes systemId, systemName, environmentId, environmentName, environemnetType, dataSourceType etc..as a JSONArray for the specified input values in the JSON object.

String

getSystem(String userName, String password, String outputFormat, String systemName)

Returns SMSystem Object for the specified systemName and outputFormat.

String

getSystemById(String userName, String password, String outputFormat, int systemId)

Returns SMSystem object for the specified systemId.

String

getSystemDocuments(String userName, String password, String outputFormat, int systemId)

Returns the list of systemDocuments for the specified systemId and outputFormat.outputFormat can be either JSON or XML.

String

getSystemId(String userName, String password, String outputFormat, String systemName)

Returns the systemId for the specified systemName in the given outputFormat.outputFormat can be either JSON or XML.

String

getSystems(String userName, String password, String outputFormat)

Returns the List of SMSystems in specified outputFormat.

String

getTable(String userName, String password, String outputFormat, int tableId, int fillOptions)

Returns SMTable object for the specified tableId.

String

getTableByName(String userName, String password, String outputFormat, int environmentId, String tableName)

Returns SMTable object for the specified environmentId and tableName.

String

getTableId(String userName, String password, String outputFormat, int environmentId, String tableName, String declarationPath)

Returns the tableId for the specified environmentId and tableName.

String

getTableIdByName(String userName, String password, String outputFormat, String systemName, String environmentName, String tableName, String declarationPath)

Returns the tableId for the specified systemName, environmentName and tableName.

String

getTables(String userName, String password, String outputFormat, int environmentId)

Returns the List of tables for the specified environmentId.

String

getTablesWithFillOptions(String userName, String password, String outputFormat, String tableIds, int fillOptions)

Returns the list of SMTable objects for the specified list of tableIds along with fillOptions value.

String

importDataDictionary(String userName, String password, String outputFormat, int environmentId, String ImportHelper)

Imports the tables on the specified environmentId.

String

importEnvironment(String userName, String password, String outputFormat, int environmentId, String dbHelperObjJson, String dbOperation, String fileExtension)

Imports the environment on the specified environmentId.

String

loadEnvironmentMetadata(String userName, String password, String outputFormat, String dbHelperObjJson)

Loads an Environment for the specified dbHelper Object.

String

loadEnvironmentMetadataById(String userName, String password, String outputFormat, int systemId, String environmentName, boolean useRefrenceId, String loadOptions)

Loads the Environment for the specified systemId, environmentName and useReferenceId.

String

publishColumn(String userName, String password, String outputFormat, int columnId)

Column is published for the specified columnId.

String

publishColumns(String userName, String password, String outputFormat, String columnIdsJsonArray)

Columns are published for the specified columnIds, specifying the list of columnIds are mandatory.

String

publishNode(String userName, String password, String outputFormat, String nodeType, int nodeId)

Node is published for the specified nodeId.

String

publishNodes(String userName, String password, String outputFormat, String nodeType, String nodeIdsJsonArray)

Nodes are published for the specified nodeIds.

String

publishTable(String userName, String password, String outputFormat, int tableId)

Table is published for the specified tableId.

String

publishTables(String userName, String password, String outputFormat, String tableIdsJsonArray)

Tables are published for the specified tableIds, specifying the list of tableIds are mandatory.

String

scanEnvironment(String userName, String password, String outputFormat, String dbHelperObjJson)

Loads an Environment for the specified dbHelper Object.

String

scanIntoEnvironment(String userName, String password, String outputFormat, int environmentId, String dbHelperJson, 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.

String

updateColumn(String userName, String password, String outputFormat, String smColumnObjJson, boolean useReferenceId)

Updates the Column for the specified SMColumn Object and useReferenceId.

String

updateDocument(String userName, String password, String outputFormat, String nodeType, String documentJsonObj)

Document is updated as specified as Document Object of the given nodeType.

String

updateEnvironmentDetails(String userName, String password, String outputFormat, String smEnvironmentObjJson)

Updates a System Environment for the specified SMEnvironment object.

String

updateEnvironmentMetadata(String userName, String password, String outputFormat, String dbEnvironmentObjJson, String operation, boolean useReferenceId)

Saves the environment for the specified DBEnvironment Object, DBProperties and useReferenceId.

String

updateIndex(String userName, String password, String outputFormat, String jsonSMIndex)

Updates the index for the specified SMIndex object.

String

updateIndexes(String userName, String password, String outputFormat, String jsonArraySMIndex)

Updates the List of indexes for the specified SMIndex Objects.

String

updateSystem(String userName, String password, String outputFormat, 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.

String

updateTable(String userName, String password, String outputFormat, String smTableObjJson, boolean useReferenceId)

Updates Table for the specified SMTable Object and useReferenceId.

String

versionEnvironment(String userName, String password, String outputFormat, int environmentId, String changeDescription, String versionLabel)

Versions the environment for the specified environmentId.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- SystemManagerService
  
  public SystemManagerService()
Method Details
- createSystem
  
  public String createSystem(String userName, String password, String outputFormat, String smSystemObjJson)
  
  Inserts a new system for the specified SMSystem Object.Specifying systemName is Mandatory. outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  SMSystem object should contain all the details pertaining to system such as name, business purpose, DBMS platform,location etc...where in systemName is mandatory.
  Without specifying the systemName, method will fail to create a new system and it returns false.
  
  Parameters:
  
  smSystemObjJson - JSON String
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - If System is created successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  Sample 'smSystemObjJson' JSON :
  {
  "systemName": "",
  "systemPrimaryMoveType": "",
  "systemDescriptionLong": "",
  "fileManagmentSystemType": "",
  "serverPlatform": "",
  "systemOwnerEmail": "",
  "specialInsructionsComments": "",
  "esbQManagerName": "",
  "endOfDayDefinition": "",
  "serverOSVersion": "",
  "totalDBSizeInGB": "",
  "dbmsPlatform": "",
  "dailyBatchExtractWindow": "",
  "dbmsVersion": "",
  "sdiFlag": "",
  "sdiDescription": "",
  "sdiClassificationName": "",
  "sdiClassificationId": "", "sdiclassifications": [
  {
  "objectTypeId": 0,
  "name": "",
  "description": "",
  "id": 0,
  "objectId": 0
  }
  ]
  }
  
  Since:
  
  6.2
- getSystems
  
  public String getSystems(String userName, String password, String outputFormat)
  
  Returns the List of SMSystems in specified outputFormat. OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  Returns all the available Systems as a List of SMSystem Objects.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - List of SMSystems in the form of JSON String.
  
  Since:
  
  6.2
- getSystem
  
  public String getSystem(String userName, String password, String outputFormat, String systemName)
  
  Returns SMSystem Object for the specified systemName and outputFormat. OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  Returns all the details such as systemName, description, systemOwner details, dataBase details and auditHistory etc.
  
  Parameters:
  
  systemName - String
  
  userName - String
  
  password - String
  
  outputFormat - String- Valid values: JSON or XML
  
  Returns:
  
  String - SMSystem object in the form of JSON or XML String.
  
  Since:
  
  6.2
- getSystemById
  
  public String getSystemById(String userName, String password, String outputFormat, int systemId)
  
  Returns SMSystem object for the specified systemId. Specifying systemId is mandatory.outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  Returns all the details such as systemName,description,systemOwner details,dataBase details and auditHistory etc.
  
  Parameters:
  
  systemId - int
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - SMSystem object in the form of JSON String.
  
  Since:
  
  6.2
- getSystemDocuments
  
  public String getSystemDocuments(String userName, String password, String outputFormat, int systemId)
  
  Returns the list of systemDocuments for the specified systemId and outputFormat.outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  Returns all the Document details of all Documents present in a specific System. Specifying the systemId is mandatory in order to retrieve the details of the Documents.
  
  Parameters:
  
  systemId - int
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - List of Document Objects in the form of JSON or XML String.
  
  Since:
  
  6.2
- getSystemId
  
  public String getSystemId(String userName, String password, String outputFormat, String systemName)
  
  Returns the systemId for the specified systemName in the given outputFormat.outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  Specifying the systemName is mandatory, based on the systemName, method will return the systemId.
  
  Parameters:
  
  systemName - String
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - systemId
  
  Since:
  
  6.2
- updateSystem
  
  public String updateSystem(String userName, String password, String outputFormat, 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.
  Specifying systemId and systemName are mandatory.All the details of the system can be updated.
  
  Parameters:
  
  smSystemObjJson - json
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - If system is updated successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  Sample 'smSystemObjJson' JSON :
  {
  "systemName": "",
  "systemId":0,
  "systemPrimaryMoveType": "",
  "systemDescriptionLong": "",
  "fileManagmentSystemType": "",
  "serverPlatform": "",
  "systemOwnerEmail": "",
  "specialInsructionsComments": "",
  "esbQManagerName": "",
  "endOfDayDefinition": "",
  "serverOSVersion": "",
  "totalDBSizeInGB": "",
  "dbmsPlatform": "",
  "dailyBatchExtractWindow": "",
  "dbmsVersion": "",
  "sdiFlag": "",
  "sdiDescription": "",
  "sdiClassificationName": "",
  "sdiClassificationId": "",
  "sdiclassifications": [
  {
  "objectTypeId": 0,
  "name": "",
  "description": "",
  "id": 0,
  "objectId": 0
  }
  ]
  }
  
  Since:
  
  6.2
- deleteSystem
  
  public String deleteSystem(String userName, String password, 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.
  Specifying the systemId is mandatory .outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  systemId - int
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - If system is deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  
  Since:
  
  6.2
- createEnvironment
  
  public String createEnvironment(String userName, String password, String outputFormat, 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. If outputFormat is not specified, by default the method will return the JSON String.
  Specifying the environmentName, databaseType is mandatory, depending on the databaseType other fields like driverName, userName, password, dbmsName, port, URL, IPAddress etc are mandatory.
  DatabaseOptions - If you want to add any database options to the environment, specify those in a string format with the comma separator. This is applicable to only RDBMS databases only.
  If the databaseType is fileType, then specification of driver name, port, URL etc... is not necessary.
  
  Parameters:
  
  smEnvironmentObjJson - JSON format
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - If Environment is created successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  Sample 'smEnvironmentObjJson' JSON :
  {
  "displayViewsInScan": false,
  "databaseOptions": "Transaction Isolation=TRANSACTION_NONE,Snowflake CaseSensitive/Non-English DBName=true,Snowflake Query Type=SELECT,Snowflake fetch Metadata by=SCHEMA,Read Only=false,Auto Commit=false,Test Connection Query='',Include Synonyms (Only Oracle)=false,Scan Nested Synonyms=false,Query Batch Limit=999,Oracle Enable SSL Connection=false,Oracle Wallet Location='',Oracle PKI Provider Position=3,Oracle SSL Server DN Match=false,Has Access To DBA=false,Support Auto Commit=false,Dump Files=false",
  "databaseName": "",
  "productionSystemName": "",
  "workflowStatus": "",
  "maximumNoOfConnectionsPerPartition": 5,
  "passwordEncrypted": true,
  "systemEnvironmentType": "",
  "sapClient": "000",
  "modelFileName": null,
  "databasePoolType": null,
  "extendedProperties": [],
  "systemName": "",
  "environmentNotes": "",
  "draft": 0,
  "kerberosPrincipal": null,
  "sshPort": 0,
  "intendedUseDescription": "",
  "rowDelimiter": "\\n",
  "visibility": 1,
  "productionSystemId": "1",
  "noOfPartitions": 2,
  "version": "1.00",
  "dataFileName": null,
  "dataProfileScoreId": 0,
  "serverPlatform": "",
  "versionLabel": "",
  "fileManagementSystemType": "",
  "databaseInstanceSchema": "",
  "systemEnvironmentName": "",
  "databasePort": "",
  "lastLoadingTime": 1554716759883,
  "status": "",
  "databaseIPAddress": "",
  "fieldDelimiter": ",",
  "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,
  "businessEntityType": "",
  "sdiFlag": "",
  "sdiDescription": "",
  "sdiClassificationName": "",
  "sdiClassificationId": "",
  "sdiclassifications": [
  {
  "objectTypeId": 0,
  "name": "",
  "description": "",
  "id": 0,
  "objectId": 0
  }
  ]
  }
  
  Since:
  
  6.2
- getEnvironments
  
  public String getEnvironments(String userName, String password, String outputFormat, int systemId)
  
  Returns the SMEnvironment Object List for the specified systemId. outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.Specifying systemId is mandatory.
  Returns all the details pertaining to the Environments, such as environmentId, environmetName, environmentType, systemId and systemName in which the Environments are present, and its associated Database details like userName, password, dbDriver information etc...
  
  Parameters:
  
  systemId - int
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - List of SMEnvironment Objects in the form JSON String.
  
  Since:
  
  6.2
- getEnvironment
  
  public String getEnvironment(String userName, String password, String outputFormat, int environmentId)
  
  Returns SMEnvironment Object for the specified environmentId. outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String. Specifying environmentId is mandatory.
  Returns all the details pertaining to a specific Environment such as environmentName, systemName in which environment is present, related DB information and its auditHistory. Specifying the environmentId is mandatory in order to retrieve the Environment Details.
  
  Parameters:
  
  environmentId - int
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - SMEnvironment object in the form of JSON or XML String.
  
  Since:
  
  6.2
- getEnvironmentByName
  
  public String getEnvironmentByName(String userName, String password, String outputFormat, int systemId, String environmentName)
  
  Returns SMEnvironment Object for the specified systemId and environmentName. outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  Returns all the details pertaining to a specific Environment such as environmentName, systemName in which environment is present, related DB information and its auditHistory.
  Specifying the systemId and environmentName is mandatory in order to retrieve the Environment Details.
  
  Parameters:
  
  systemId - int
  
  environmentName - String
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - SMEnvironment Object in the form of JSON or XML String.
  
  Since:
  
  6.2
- getEnvironmentConnectionProperties
  
  public String getEnvironmentConnectionProperties(String userName, String password, String outputFormat, String smEnvironmentObjJson)
  
  Returns DBProperties Object for the specified SMEnvironment object. outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  Returns all the connection details such as username, password, driver details of a Environment. It is mandatory to specify environmentName and systemId in which the Environment is present.
  
  Parameters:
  
  smEnvironmentObjJson - JSON format
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - Environment DBProperties in the form of JSON String.
  
  Sample 'smEnvironmentObjJson' JSON :
  
  {
  "displayViewsInScan": false,
  "databaseOptions": null,
  "databaseName": "",
  "productionSystemName": "",
  "workflowStatus": "",
  "maximumNoOfConnectionsPerPartition": 5,
  "passwordEncrypted": true,
  "systemEnvironmentType": "",
  "sapClient": "000",
  "modelFileName": null,
  "databasePoolType": null,
  "extendedProperties": [],
  "tables": [],
  "systemName": "",
  "environmentNotes": "",
  "draft": 0,
  "kerberosPrincipal": null,
  "sshPort": 0,
  "intendedUseDescription": "",
  "rowDelimiter": "\\n",
  "visibility": 1,
  "productionSystemId": "",
  "noOfPartitions": 2,
  "version": "1.00",
  "dataFileName": null,
  "dataProfileScoreId": 0,
  "serverPlatform": "",
  "versionLabel": "",
  "fileManagementSystemType": "",
  "databaseInstanceSchema": "",
  "systemEnvironmentName": "",
  "databasePort": "",
  "lastLoadingTime": 1554716759883,
  "status": "",
  "databaseIPAddress": "",
  "fieldDelimiter": ",",
  "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
  }
  
  Since:
  
  6.2
- getEnvironmentId
  
  public String getEnvironmentId(String userName, String password, String outputFormat, int systemId, String environmentName)
  
  Returns the environmentId for the specified systemId and environmentName. outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  Specifying the systemId and environmentName are mandatory.
  
  Parameters:
  
  systemId - int
  
  environmentName - String
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - environmentId
  
  Since:
  
  6.2
- getEnvironmentIdByName
  
  public String getEnvironmentIdByName(String userName, String password, String outputFormat, String systemName, String environmentName)
  
  Returns the environmentId for the specified systemName and environmentName. outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  Specifying the systemName and environmentName is mandatory.
  
  Parameters:
  
  systemName - String
  
  environmentName - String
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - environmentId
  
  Since:
  
  6.2
- updateEnvironmentDetails
  
  public String updateEnvironmentDetails(String userName, String password, String outputFormat, String smEnvironmentObjJson)
  
  Updates a System Environment for the specified SMEnvironment object. outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  When updating the environment, databaseType can be changed from one type to other and depending on the database type the details has to be specified.
  DatabaseOptions - If you want to add any database options to the environment, specify those in a string format with the comma separator. This is applicable to only RDBMS databases only.
  If the databaseType of environment is ETL, then environment cannot be updated from one databaseType to another or vice versa
  
  Parameters:
  
  smEnvironmentObjJson - JSON format
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - If Environment is updated successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  Sample 'smEnvironmentObjJson' JSON :
  {
  "displayViewsInScan": false,
  "databaseOptions": "Transaction Isolation=TRANSACTION_NONE,Snowflake CaseSensitive/Non-English DBName=true,Snowflake Query Type=SELECT,Snowflake fetch Metadata by=SCHEMA,Read Only=false,Auto Commit=false,Test Connection Query='',Include Synonyms (Only Oracle)=false,Scan Nested Synonyms=false,Query Batch Limit=999,Oracle Enable SSL Connection=false,Oracle Wallet Location='',Oracle PKI Provider Position=3,Oracle SSL Server DN Match=false,Has Access To DBA=false,Support Auto Commit=false,Dump Files=false",
  "databaseName": "",
  "productionSystemName": "",
  "workflowStatus": "",
  "maximumNoOfConnectionsPerPartition": 5,
  "passwordEncrypted": true,
  "systemEnvironmentType": "",
  "sapClient": "000",
  "modelFileName": null,
  "databasePoolType": null,
  "extendedProperties": [],
  "tables": [],
  "systemName": "",
  "environmentNotes": "",
  "draft": 0,
  "kerberosPrincipal": null,
  "sshPort": 0,
  "intendedUseDescription": "",
  "rowDelimiter": "\\n",
  "visibility": 1,
  "productionSystemId": "",
  "noOfPartitions": 2,
  "version": "1.00",
  "dataFileName": null,
  "dataProfileScoreId": 0,
  "serverPlatform": "",
  "versionLabel": "",
  "fileManagementSystemType": "",
  "databaseInstanceSchema": "",
  "systemEnvironmentName": "",
  "databasePort": "",
  "lastLoadingTime": 1554716759883,
  "status": "",
  "databaseIPAddress": "",
  "fieldDelimiter": ",",
  "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,
  "businessEntityType": "",
  "sdiFlag": "",
  "sdiDescription": "",
  "sdiClassificationName": "",
  "sdiClassificationId": 0,
  "sdiclassifications": [
  {
  "objectTypeId": 0,
  "name": "",
  "description": "",
  "id": 0,
  "objectId": 0
  }
  ]
  }
  
  Since:
  
  6.2
- deleteEnvironment
  
  public String deleteEnvironment(String userName, String password, String outputFormat, int environmentId)
  
  Removes System Environment for the specified environmentId. outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  Specifying environmentId is mandatory. Environment cannot be deleted if the environment is being used as production environment.
  
  Parameters:
  
  environmentId - int
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - If Environment is deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  
  Since:
  
  6.2
- loadEnvironmentMetadata
  
  public String loadEnvironmentMetadata(String userName, String password, String outputFormat, String dbHelperObjJson)
  
  Loads an Environment for the specified dbHelper Object. Specifying the dbHelper object in the form of json is mandatory.
  outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON string.
  
  The following properties in the dbHelper object are mandatory:
  
  databaseType - This defines the type of the database to be scanned and saved. For values reference at DBProperties.DatabaseType. Depending on this value, mandatory values will vary from one database to other.
  
  If the databaseType value retrieved from dbHelper Object is RDBMS database, then the environment is loaded by specifying the dbUrl, dbDriver,dbUserName,dbPassword, dbName, dbSchema, databaseType, ipAddress, scanCriteria,readColumns,readComments,readTables, readViews, readSynonyms and selectedTables/selectedViews/selectedSynonyms.
  
  If the databaseType value retrieved from dbHelper Object is file based database, then the environment is loaded by specifying the filePath i.e the location from which the file can be read, scanCriteria,readColumns, readComments, readTables, readViews,readSynonyms and selectedTables/selectedViews/selectedSynonyms.
  
  scanCriteria - This defines the selection criteria of objects(TABLES/VIEWS/SYNONYMS/COMPONENTS) 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/COMPONENTS.
  
  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.
  
  modelType & readLogicalColumns - These properties from the dbHelper object are used for only ERWIN file based databases.
  modelType defines the order in which the tables are displayed and readLogicalColumns value defines whether to skip logical columns or not.
  The value of modelType value can be either PHYSICAL OR LOGICAL (For values reference at DBHelper.ModelType)). DBHelper.ModelType 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.
  
  Parameters:
  
  dbHelperObjJson - in json format
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - DBEnvironment object in the form of JSON String.
  
  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", "modelType": "PHYSICAL", ==> (for erwin & json databases etc)
  "useReferenceId": false ==> (for erwin & cwm databases)
  }
  
  Since:
  
  9.0
- loadEnvironmentMetadataById
  
  public String loadEnvironmentMetadataById(String userName, String password, String outputFormat, int systemId, String environmentName, boolean useRefrenceId, String loadOptions)
  
  Loads the Environment for the specified systemId, environmentName and useReferenceId. outputFormat can be either Json or XML. If outputFormat is not specified, by default the method will return the Json String.
  Specifying the systemId, environementName and useReferenceId is mandatory. useReferenceId value for ERWIN and CWM is true, for other databaseTypes it is false.
  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.
  loadOptions parameter is used to specify the loading options and the valid values for this are VALID, INVALID and BOTH.
  VALID -Loads valid tables and columns.
  INVALID -Loads invalid tables and columns.
  BOTH -Loads all the valid and invalid tables and columns.
  
  Parameters:
  
  systemId - int
  
  environmentName - String
  
  useRefrenceId - boolean
  
  loadOptions - String
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - DBEnvironment object in the form of JSON or XML String.
  
  Since:
  
  6.2
- updateEnvironmentMetadata
  
  public String updateEnvironmentMetadata(String userName, String password, String outputFormat, String dbEnvironmentObjJson, String operation, boolean useReferenceId)
  
  Saves the environment for the specified DBEnvironment Object, DBProperties and useReferenceId. Specification of DBEnvironment Object, DBProperties Object, systemId, environmentId, databaseType and useReferenceId are mandatory.
  outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  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.
  
  Parameters:
  
  dbEnvironmentObjJson - JSON format
  
  operation - DBProperties.Operation
  
  useReferenceId - boolean
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - If Environment is saved successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  Sample 'dbEnvironmentObjJson' JSON :
  
  {
  "environmentName": "",
  "system": {
  "systemId": 0
  },
  "schemas": {
  "dbo": {
  "schemaName": "",
  "viewMap": {},
  "synonymMap": {},
  "tableMap": {
  "dbo.table1": {
  "tableName": "",
  "tableComments": "",
  "createdBy": "",
  "createdDateTime": 1428994708798,
  "lastModifiedBy": "",
  "lastModifiedDateTime": 1428994708798,
  "tableType": "",
  "userDefined1": "",
  "userDefined2": "",
  "userDefined3": "",
  "userDefined4": "",
  "userDefined5": "",
  "userDefined6": "",
  "userDefined7": "",
  "userDefined8": "",
  "userDefined9": "",
  "userDefined10": "",
  "columnMap": {
  "column1": {
  "columnName": "",
  "datatype": "",
  "length": "50",
  "precision": "20",
  "createdBy": "",
  "createdDatetime": 1428994708798,
  "lastModifiedBy": "",
  "lastModifiedDatetime": 1428994708798,
  "scale": "10",
  "userDefined1": "",
  "userDefined2": "",
  "userDefined3": "",
  "userDefined4": "",
  "userDefined5": "",
  "userDefined6": "",
  "userDefined7": "",
  "userDefined8": "",
  "userDefined9": "",
  "userDefined10": "",
  "businessEntityType": ""
  }
  }
  }
  }
  }
  }
  }
  
  Since:
  
  6.2
- createTable
  
  public String createTable(String userName, String password, String outputFormat, String smTableObjJson)
  
  Inserts new Table for the specified SMTable Object. Specifying the environmentId, tableName and tableType are mandatory to create the Table. outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  smTableObjJson - json
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - If Table is created successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  
  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": "TABLE",
  "extendedProperties": [],
  "environmentId": 0,
  "logicalTableName": null,
  "userDefined10": "",
  "marked": false,
  "systemId": 0,
  "rootTable": true,
  "tableDefinition": null,
  "columnIndexes": [],
  "tableReferenceId": null,
  "associatedBusinessTerm": "",
  "dataProfileScoreId": 0,
  "environment": null,
  "totalRowsCount": 0,
  "userDefined8": "",
  "userDefined9": "",
  "metadataSource": "",
  "userDefined6": "",
  "userDefined7": "",
  "userDefined4": "",
  "userDefined5": "",
  "tableId": 0,
  "userDefined2": "",
  "systemEnvironmentName": "",
  "usedInGapAnalysis": true,
  "userDefined3": "",
  "userDefined1": "",
  "fileType": null,
  "fileLocation": "",
  "businessEntityType": "",
  "status": ""
  , "sdiFlag": "",
  "sdiDescription": "",
  "sdiClassificationName": "",
  "sdiClassificationId": "",
  "sdiclassifications": [
  {
  "objectTypeId": 0,
  "name": "",
  "description": "",
  "id": 0,
  "objectId": 0
  }
  ]
  }
  
  Since:
  
  6.2
- getTable
  
  public String getTable(String userName, String password, String outputFormat, int tableId, int fillOptions)
  
  Returns SMTable object for the specified tableId. outputFormat can be either Json or XML. If outputFormat is not specified, by default the method will return the JSON String.
  Here fillOptions can be Integer values of either 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)).
  Returns all the details pertaining to table such as tableName, tableDefinition, environmentName in which table is present etc... Specifying the tableId is mandatory in order to fetch the table details.
  
  Parameters:
  
  tableId - int
  
  fillOptions - APIConstants.SMFillOptions int
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - SMTable object in the form of JSON or XML String.
  
  Since:
  
  6.2
- getTableByName
  
  public String getTableByName(String userName, String password, String outputFormat, int environmentId, String tableName)
  
  Returns SMTable object for the specified environmentId and tableName. outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  This method results in displaying all the details related to table, where in specifying the environmentId, tableName are mandatory.
  
  Parameters:
  
  environmentId - int
  
  tableName - String
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - SMTable object in the form of JSON String.
  
  Since:
  
  6.2
- getTableId
  
  public String getTableId(String userName, String password, String outputFormat, int environmentId, String tableName, String declarationPath)
  
  Returns the tableId for the specified environmentId and tableName. outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  Specifying the environmentId and tableName are mandatory.
  
  Parameters:
  
  environmentId - int
  
  tableName - String
  
  declarationPath - String
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - tableId
  
  Since:
  
  6.2
- getTableIdByName
  
  public String getTableIdByName(String userName, String password, String outputFormat, String systemName, String environmentName, String tableName, String declarationPath)
  
  Returns the tableId for the specified systemName, environmentName and tableName. outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  Specifying the systemName, environmentName and tableName are mandatory.
  
  Parameters:
  
  systemName - String
  
  environmentName - String
  
  tableName - String
  
  declarationPath - String
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - tableId
  
  Since:
  
  6.2
- getTables
  
  public String getTables(String userName, String password, String outputFormat, int environmentId)
  
  Returns the List of tables for the specified environmentId. Specifying the environemntId is mandatory in order to retrieve the tables present in the specified environment.
  outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  environmentId - int
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - List of SMTable objects in the form of JSON or XML String.
  
  Since:
  
  6.2
- updateTable
  
  public String updateTable(String userName, String password, String outputFormat, String smTableObjJson, boolean useReferenceId)
  
  Updates Table for the specified SMTable Object and useReferenceId. Specifying the SMTable Object and useReferenceId is mandatory, useReferenceId value for ERWIN and CWM is true, whereas for other database types it is false.
  outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  In SMTable Object specifying the environmentId, tableName and tableId are mandatory. If SMTable is updated successfully, RequestStatus.isRequestSuccess() will return true otherwise false.
  
  Parameters:
  
  smTableObjJson - SMTable Object
  
  useReferenceId - boolean
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - If Table is updated successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  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": "TABLE",
  "extendedProperties": [],
  "environmentId": 0,
  "logicalTableName": null,
  "userDefined10": "",
  "marked": false,
  "systemId": 0,
  "rootTable": true,
  "tableDefinition": null,
  "columnIndexes": [],
  "tableReferenceId": null,
  "associatedBusinessTerm": "",
  "dataProfileScoreId": 0,
  "environment": null,
  "totalRowsCount": 0,
  "userDefined8": "",
  "userDefined9": "",
  "metadataSource": "",
  "userDefined6": "",
  "userDefined7": "",
  "userDefined4": "",
  "userDefined5": "",
  "tableId": 0,
  "userDefined2": "",
  "systemEnvironmentName": "",
  "usedInGapAnalysis": true,
  "userDefined3": "",
  "userDefined1": "",
  "fileType": null,
  "fileLocation": "",
  "businessEntityType": "",
  "status": ""
  , "sdiFlag": "",
  "sdiDescription": "",
  "sdiClassificationName": "",
  "sdiClassificationId": "",
  "sdiclassifications": [
  {
  "objectTypeId": 0,
  "name": "",
  "description": "",
  "id": 0,
  "objectId": 0
  }
  ]
  }
  
  Since:
  
  6.2
- deleteTable
  
  public String deleteTable(String userName, String password, String outputFormat, int tableId)
  
  Removes the table for the specified tableId. Specifying the tableId is mandatory, the columns associated with specific table are first deleted and the corresponding table meta data is then deleted.
  outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  tableId - int
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - If Table is deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  
  Since:
  
  6.2
- createColumn
  
  public String createColumn(String userName, String password, String outputFormat, String smColumnObjJson)
  
  Inserts Column for the specified SMColumn Object. When creating a new column the SMColumn Object is mandatory.
  outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  In SMColumn Object, providing the details regarding the tableId and tableName is necessary, according to which the column gets created under that particular table.
  
  Parameters:
  
  smColumnObjJson - in JSON format
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - If Column is created successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  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,
  "columnType": "ENTITY_ELEMENT",
  "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,
  "sdiclassifications": [
  {
  "objectTypeId": 0,
  "name": "",
  "description": "",
  "id": 0,
  "objectId": 0
  }
  ]
  }
  
  Since:
  
  6.2
- getColumn
  
  public String getColumn(String userName, String password, String outputFormat, int columnId)
  
  Returns SMColumn object for the specified columnId. Specifying the columnId is mandatory and it returns all the details pertaining to column such as columnName, tableName in which the column is present, columnLength, columnPrecision etc...
  outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  columnId - int
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - SMColumn object in the form of JSON String.
  
  Since:
  
  6.2
- getColumnByName
  
  public String getColumnByName(String userName, String password, String outputFormat, int tableId, String columnName, int fillOptions)
  
  Returns SMColumn Object for the specified tableId and columnName. Specifying the tableId and columnName is mandatory, it returns the column details of the table such as columnName,tableName in which the column is present,columnLength,columnPrecision etc...
  Here fillOptions parameter takes value of either 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.
  outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  tableId - int
  
  columnName - String
  
  fillOptions - APIConstants.SMFillOptions int
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - SMColumn object in the form of JSON String.
  
  Since:
  
  6.2
- getColumnId
  
  public String getColumnId(String userName, String password, String outputFormat, int tableId, String columnName)
  
  Returns the columnId for the specified tableId and columnName. outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  Specifying the tableId and columnName are mandatory.
  
  Parameters:
  
  tableId - int
  
  columnName - String
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - columnId in the form of JSON or XML String.
  
  Since:
  
  6.2
- getColumnIdByBreadcrumb
  
  public String getColumnIdByBreadcrumb(String userName, String password, String outputFormat, String systemName, String environmentName, String tableName, String columnName)
  
  Returns the columnId for the specified environmentName, systemName, tableName and columnName. outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  Specifying the environmentName, systemName, tableName and columnName are mandatory.
  
  Parameters:
  
  systemName - String
  
  environmentName - String
  
  tableName - String
  
  columnName - String
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - columnId in the form of JSON or XML String.
  
  Since:
  
  6.2
- getColumns
  
  public String getColumns(String userName, String password, String outputFormat, int tableId)
  
  Returns list of SMColumn Object for the specified tableId. outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  Returns the list of columns associated with the particular table, for which specifying the tableId is mandatory in order to retrieve the columns.
  
  Parameters:
  
  tableId - int
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - List of SMColumn objects in the form of JSON String i.e List of columns of a particular Table.
  
  Since:
  
  6.2
- updateColumn
  
  public String updateColumn(String userName, String password, String outputFormat, String smColumnObjJson, boolean useReferenceId)
  
  Updates the Column for the specified SMColumn Object and useReferenceId. Specifying the tableId, columnId and columnName in SMColumn Object and useReferenceId are mandatory,which helps in updating all the details of the column specified.
  outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  smColumnObjJson - JSON
  
  useReferenceId - boolean
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - If Column is updated successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  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,
  "columnType": "ENTITY_ELEMENT",
  "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,
  "sdiclassifications": [
  {
  "objectTypeId": 0,
  "name": "",
  "description": "",
  "id": 0,
  "objectId": 0
  }
  ]
  }
  
  Since:
  
  6.2
- deleteColumn
  
  public String deleteColumn(String userName, String password, String outputFormat, int columnId)
  
  Removes column for the specified columnId. Specifying the columnId is mandatory, based on which the column gets deleted from the table.
  outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  columnId - int
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - If Column is deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  
  Since:
  
  6.2
- addDocument
  
  public String addDocument(String userName, String password, String outputFormat, String nodeType, int nodeId, String documentObjJson)
  
  Document is added for the specified nodeId of nodeType. specifying the nodeId, nodeType, documentName, documentObject or documentLink are mandatory.
  nodeType can be either SM_SYSTEM, SM_ENVIRONMENT. Depending upon the nodeType, nodeId will be either systemId or environmentId.
  outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  nodeType - Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENT
  
  nodeId - int
  
  documentObjJson - String Document Object.
  
  Returns:
  
  String - If Document is added successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  Sample 'documentObjJson' JSON :
  
  {
  "documentIntendedPurpose": "",
  "userData": null,
  "documentReferenceNumber": "",
  "documentType": "",
  "documentName": "",
  "documentApprovedBy": "",
  "documentObject": "",
  "approvalRequired": false,
  "documentOwner": "",
  "documentLink": "",
  "documentId": 0,
  "documentReference": "",
  "documentStatus": "",
  "documentApprovedDate": 1460701213000
  }
  
  Since:
  
  7.0
- addDocumentWithNodeName
  
  public String addDocumentWithNodeName(String userName, String password, String outputFormat, String nodeName, String parentNodeType, int parentNodeId, String documentObjJson)
  
  Document is added for the specified nodeName, parentNodeId of parentNodeType. Specifying the parentNodeId, parentNodeType, nodeName, documentName, documentObject or docuentLink are mandatory.
  parentNodeType can be either SM_SYSTEM, SM_ENVIRONMENT. Depending upon the parentNodeType, parentNodeId will be either systemId or environmentId.
  If you want to add the document to the system then the parentNodeType is SM_SYSTEM, and the parentNodeId is -1.
  If you want to add the document to the environment then the parentNodeType is SM_SYSTEM, and the parentNodeId is systemId.
  outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  nodeName - String
  
  parentNodeType - Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENT
  
  parentNodeId - int
  
  documentObjJson - String Document Object.
  
  Returns:
  
  String - If Document is added successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  Sample 'documentObjJson' JSON :
  
  {
  "documentIntendedPurpose": "",
  "userData": null,
  "documentReferenceNumber": "",
  "documentType": "",
  "documentName": "",
  "documentApprovedBy": "",
  "documentObject": "",
  "approvalRequired": false,
  "documentOwner": "",
  "documentLink": "",
  "documentId": 0,
  "documentReference": "",
  "documentStatus": "",
  "documentApprovedDate": 1460701213000
  }
  
  Since:
  
  7.0
- deleteDocuments
  
  public String deleteDocuments(String userName, String password, String outputFormat, String nodeType, int nodeId)
  
  Deletes the documents of the specified nodeId of nodeType. Specifying the nodeId and nodeType are mandatory.
  nodeType can be either SM_SYSTEM, SM_ENVIRONMENT. Depending upon the nodeType, nodeId will be either systemId or environmentId.
  outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  nodeType - Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENT
  
  nodeId - int
  
  Returns:
  
  String - If Documents are deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  
  Since:
  
  7.0
- deleteDocumentsByNodeName
  
  public String deleteDocumentsByNodeName(String userName, String password, String outputFormat, String nodeName, String parentNodeType, int parentNodeId)
  
  Documents are deleted for the specified nodeName, parentNodeId of parentNodeType. Specifying the parentNodeId, parentNodeType, nodeName are mandatory.
  nodeType can be either SM_SYSTEM, SM_ENVIRONMENT. Depending upon the nodeType, nodeId will be either systemId or environmentId.
  If the parentNodeType is SM_SYSTEM, then the parentNodeId is -1.
  If the parentNodeType is SM_ENVIRONMENT, then the parentNodeId is systemId.
  outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  nodeName - String
  
  parentNodeType - Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENT
  
  parentNodeId - int
  
  Returns:
  
  String - If Documents are deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  
  Since:
  
  7.0
- deleteSystemDocuments
  
  public String deleteSystemDocuments(String userName, String password, String outputFormat, int systemId)
  
  Deletes the systemDocuments for the specified systemId. Specifying the systemId is mandatory.
  outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  systemId - int
  
  Returns:
  
  String - If Documents are deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  
  Since:
  
  7.0
- deleteSystemDocumentsBySystemName
  
  public String deleteSystemDocumentsBySystemName(String userName, String password, String outputFormat, String systemName)
  
  Deletes the systemDocuments for the specified systemName. Specifying the systemName is mandatory.
  outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  systemName - String
  
  Returns:
  
  String - If Documents are deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  
  Since:
  
  7.0
- deleteEnvironmentDocumentsById
  
  public String deleteEnvironmentDocumentsById(String userName, String password, String outputFormat, int environmentId)
  
  Deletes the Environment Documents of the specified environmentId. Specifying the environmentId is mandatory.
  outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  environmentId - int
  
  Returns:
  
  String - If Documents are deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  
  Since:
  
  7.0
- deleteEnvironmentDocuments
  
  public String deleteEnvironmentDocuments(String userName, String password, String outputFormat, int systemId, String environmentName)
  
  Deletes the Environment Documents of the specified environmentName and systemId. Specifying the environmentName and systemId are mandatory.
  outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  systemId - int
  
  environmentName - String
  
  Returns:
  
  String - If Documents are deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  
  Since:
  
  7.0
- deleteDocumentById
  
  public String deleteDocumentById(String userName, String password, String outputFormat, String nodeType, int docId)
  
  Deletes the Document for the specified docId of nodeType. Specifying the docId and nodeType are mandatory.
  nodeType can be either SM_SYSTEM, SM_ENVIRONMENT. Depending upon the nodeType, nodeId will be either systemId or environmentId.
  outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  nodeType - Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENT
  
  docId - int
  
  Returns:
  
  String - If Documents are deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  
  Since:
  
  7.0
- getDocumentById
  
  public String getDocumentById(String userName, String password, String outputFormat, String nodeType, int docId)
  
  Returns the Document object for the specified docId of nodeType.
  Specification of docId is mandatory, based on which it returns the document information, such as documentName, documentType, documentOwner, documentId, documentObject, documentReference, auditHistory details etc...
  nodeType can be either SM_SYSTEM, SM_ENVIRONMENT. Depending upon the nodeType, nodeId will be either systemId or environmentId.
  outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  nodeType - Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENT
  
  docId - int
  
  Returns:
  
  String - If Document is returned successfully, it will return success message otherwise returns failure message.
  
  Since:
  
  7.0
- getDocumentsByIds
  
  public String getDocumentsByIds(String userName, String password, String outputFormat, String nodeType, String docIdsJsonArray)
  
  Returns the List of Document objects for the specified List of docId's of the nodeType.
  Specification of docId's and nodeType are mandatory, based on which it returns the document information, such as documentName, documentType, documentOwner, documentId, documentObject, documentReference, auditHistory details etc...
  nodeType can be either SM_SYSTEM, SM_ENVIRONMENT. Depending upon the nodeType, nodeId will be either systemId or environmentId.
  outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  nodeType - Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENT
  
  docIdsJsonArray - List
  
  Returns:
  
  String - If Documents are returned successfully, it will return success message otherwise returns failure message.
  
  Since:
  
  7.0
- getEnvironmentDocuments
  
  public String getEnvironmentDocuments(String userName, String password, String outputFormat, int environmentId)
  
  Returns the List of Document objects for the specified environmentId. Returns all the documents of the particular environment.
  Specification of environmentId is mandatory, based on which it returns the document information, such as documentName, documentType, documentOwner, documentId, documentObject, documentReference, auditHistory details etc...
  outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  environmentId - int
  
  Returns:
  
  String - If Documents are returned successfully, it will return success message otherwise returns failure message.
  
  Since:
  
  7.0
- deleteDocumentsByIds
  
  public String deleteDocumentsByIds(String userName, String password, String outputFormat, String nodeType, String docIdsJsonArray)
  
  Documents are deleted for the specified List of docIds of the given nodeType. Specifying the docIds, nodeType are mandatory.
  nodeType can be either SM_SYSTEM, SM_ENVIRONMENT. Depending upon the nodeType, nodeId will be either systemId or environmentId.
  outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  nodeType - Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENT
  
  docIdsJsonArray - List
  
  Returns:
  
  String - If Documents are deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  
  Since:
  
  7.0
- updateDocument
  
  public String updateDocument(String userName, String password, String outputFormat, String nodeType, String documentJsonObj)
  
  Document is updated as specified as Document Object of the given nodeType. Specifying the nodeType, documentId, documentName are mandatory.
  nodeType can be either SM_SYSTEM, SM_ENVIRONMENT. nodeType can be either SM_SYSTEM, SM_ENVIRONMENT. Depending upon the nodeType, nodeId will be either systemId or environmentId.
  outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  nodeType - Node Object - valid types - SM_SYSTEM, SM_ENVIRONMENT
  
  documentJsonObj - String - Document Object
  
  Returns:
  
  String - If Document is updated successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  Sample 'documentJsonObj' JSON :
  
  {
  "documentIntendedPurpose": "",
  "userData": null,
  "documentReferenceNumber": "",
  "documentType": "",
  "documentName": "",
  "documentApprovedBy": "",
  "documentObject": "",
  "approvalRequired": false,
  "documentOwner": "",
  "documentLink": "",
  "documentId": 0,
  "documentReference": "",
  "documentStatus": "",
  "documentApprovedDate": 1460701213000
  }
  
  Since:
  
  7.0
- cloneEnvironment
  
  public String cloneEnvironment(String userName, String password, String outputFormat, String srcSystemName, String srcEnvironmentName, String tgtSystemName, String tgtEnvironmentName)
  
  Clone Environment creates another copy of the Environment. i.e it copies the environment specified as srcEnvironmentName of srcSystemName and creates another copy at the specified tgtSystemName with tgtEnvironmentName.
  Specifying srcSystemName, srcEnvironmentName, tgtSystemName, tgtEnvironmentName are mandatory.
  outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  srcSystemName - String
  
  srcEnvironmentName - String
  
  tgtSystemName - String
  
  tgtEnvironmentName - String
  
  Returns:
  
  String - If Environment is cloned successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  
  Since:
  
  7.0
- cloneEnvironmentBySystemId
  
  public String cloneEnvironmentBySystemId(String userName, String password, String outputFormat, int srcSystemId, String srcEnvironmentName, int tgtSystemId, String tgtEnvironmentName)
  
  Clone Environment creates another copy of the Environment. i.e it copies the environment specified as srcEnvironmentName at srcSystemId and creates another copy at the specified tgtSystemId with tgtEnvironmentName.
  Specifying srcSystemId, srcEnvironmentName, tgtSystemId, tgtEnvironmentName are mandatory.
  outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  srcSystemId - int
  
  srcEnvironmentName - String
  
  tgtSystemId - int
  
  tgtEnvironmentName - String
  
  Returns:
  
  String - If Environment is cloned successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  
  Since:
  
  7.0
- cloneEnvironmentById
  
  public String cloneEnvironmentById(String userName, String password, String outputFormat, int environmentId, String tgtSystemName, String tgtEnvironmentName)
  
  Clone Environment creates another copy of the Environment. i.e it copies the environment specified with environmentId and creates another copy at the specified tgtSystemName with tgtEnvironmentName.
  Specifying environmentId, tgtSystemName, tgtEnvironmentName are mandatory.
  outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  environmentId - int
  
  tgtSystemName - String
  
  tgtEnvironmentName - String
  
  Returns:
  
  String - If Environment is cloned successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  
  Since:
  
  7.0
- getEnvironmentById
  
  public String getEnvironmentById(String userName, String password, String outputFormat, int environmentId, boolean fillMetadata, boolean useReferenceId)
  
  Returns SMEnvironment Object for the specified environmentId.Specifying the environmentId is mandatory.
  Returns all the details pertaining to a specific Environment such as environmentName, systemName in which environment is present, related DB information and its auditHistory. Specifying the environmentId is mandatory in order to retrieve the Environment Details.
  
  fillMetadata and useReferenceId takes the values as true or false. If the fillMetadata value is false, it simply returns the SMEnvironment object i.e all details relating to the environmentId specified.
  If fillMetadata is true and useReferenceId is true, then it returns the environment based on checking the table referenceId which is set to the tables and column referenceId set in the columns of those tables in the specific environment.
  
  If fillMetadata is true and useReferenceId is false, then it returns the environment with out checking the table referenceId and the column referenceId of those tables and columns of the specific environment.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  environmentId - Integer
  
  fillMetadata - boolean
  
  useReferenceId - boolean
  
  Returns:
  
  String - SMEnvironment object in the form of JSON or XML String.
- getColumnById
  
  public String getColumnById(String userName, String password, String outputFormat, int columnId, int fillOptions)
  
  Returns SMColumn object for the specified columnId.
  Specifying the columnId and fillOptions are mandatory. The returned SMColumn object contains all the details pertaining to column such as column name, table name in which the column is present, column length, column precision etc... and also contains details of column indexes, column extended properties ,valid values and extended properties of valid values based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
  Here fillOptions parameter takes value of either 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.
  OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  columnId - int
  
  fillOptions - APIConstants.SMFillOptions int
  
  Returns:
  
  String - SMColumn object
  
  Since:
  
  8.2.1
- getColumnsById
  
  public String getColumnsById(String userName, String password, 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. Each column object contains details like column name,column datatype,column length and column precision etc.. and also contains details of column indexes, column extended properties ,valid values and extended properties of valid values based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
  Here fillOptions parameter takes value of either 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.
  OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  tableId - int
  
  fillOptions - APIConstants.SMFillOptions int
  
  Returns:
  
  String - List of SMColumn Objects
  
  Since:
  
  8.2.1
- getIndexColumns
  
  public String getIndexColumns(String userName, String password, String outputFormat, int tableId, 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.. and also contains details of column indexes,column extended properties , valid values and extended properties of valid values based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
  Here fillOptions parameter takes value of either 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.
  OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  tableId - int
  
  indexName - String
  
  fillOptions - APIConstants.SMFillOptions int
  
  Returns:
  
  SMColumn object
  
  Since:
  
  8.2.1
- addIndex
  
  public String addIndex(String userName, String password, String outputFormat, String jsonSMIndex)
  
  Inserts a new index for the specified SMIndex Object. SMIndex object should contain all the details pertaining to index such as index name which is mandatory, type,owner etc.. and SMIndex object should also contain either column object or list of column objects to which the index need to be added where columnId is mandatory in each column object.
  Without specifying the index name and columnId, method will fail to create a new index and it returns false.
  OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  jsonSMIndex - JSON String
  
  Returns:
  
  String - If Index is added successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  
  Sample 'jsonSMIndex' JSON :
  
  {
  "id":0, "tableId":0, "name": "",
  "owner": "",
  "uniqueness": "",
  "sortOrder": "",
  "type": "",
  "ordinalPosition": 0,
  "columns": [
  {
  "columnId": 0
  }
  ]
  }
  
  Since:
  
  8.2.1
- addIndexByColumnId
  
  public String addIndexByColumnId(String userName, String password, String outputFormat, int columnId, 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..
  Specifying the columnId and SMIndex object are mandatory.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  columnId - int
  
  jsonSMIndex - String
  
  Returns:
  
  String - If Index is added successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  Sample 'jsonSMIndex' JSON :
  
  {
  "id":0, "tableId":0, "name": "",
  "owner": "",
  "uniqueness": "",
  "sortOrder": "",
  "type": "",
  "ordinalPosition": 0
  }
  
  Since:
  
  8.2.1
- addIndexes
  
  public String addIndexes(String userName, String password, String outputFormat, 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.
  Specifying index name in the List of indexes objects and columnId in each column object are mandatory.
  OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  jsonArraySMIndex - String - smIndex Object list
  
  Returns:
  
  String - If Indexes are added successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  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
  }
  ]
  }
  ]
  
  Since:
  
  8.2.1
- addIndexesByColumnId
  
  public String addIndexesByColumnId(String userName, String password, String outputFormat, int columnId, String jsonArraySMIndex)
  
  Inserts list of indexes for the specified columnId where in each SMIndex object should contain index name.
  Specifying columnId and list of SMIndex objects are mandatory.
  OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  columnId - int
  
  jsonArraySMIndex - String
  
  Returns:
  
  String - If indexes are added successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML 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
  }
  ]
  
  Since:
  
  8.2.1
- updateIndex
  
  public String updateIndex(String userName, String password, String outputFormat, String jsonSMIndex)
  
  Updates the index for the specified SMIndex object. All the information pertaining to the index can be updated. Specifying the index id and name is mandatory to update the index.
  OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  jsonSMIndex - String - smIndex Object
  
  Returns:
  
  String - If index is updated successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  Sample 'jsonSMIndex' JSON :
  
  {
  "id":0, "tableId":0, "name": "",
  "owner": "",
  "uniqueness": "",
  "sortOrder": "",
  "type": "",
  "ordinalPosition": 0,
  "columns": [
  {
  "columnId": 0
  }
  ]
  }
  
  Since:
  
  8.2.1
- updateIndexes
  
  public String updateIndexes(String userName, String password, String outputFormat, String jsonArraySMIndex)
  
  Updates the List of indexes for the specified SMIndex Objects. All the information pertaining to the each index can be updated.
  Specifying index ids and names in list of index objects are mandatory.
  OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  jsonArraySMIndex - String - smIndex objects list
  
  Returns:
  
  String - If Indexes are updated successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML 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
  }
  ]
  }
  ]
  
  Since:
  
  8.2.1
- deleteIndexById
  
  public String deleteIndexById(String userName, String password, String outputFormat, int indexId)
  
  Removes SMIndex for the specified indexId.
  OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  indexId - int
  
  Returns:
  
  String - If index is deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  
  Since:
  
  8.2.1
- deleteIndex
  
  public String deleteIndex(String userName, String password, String outputFormat, String jsonSMIndex)
  
  Removes index for the specified SMIndex object. Specifying index id in SMIndex object is mandatory.
  OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  jsonSMIndex - String - smIndex Object
  
  Returns:
  
  String - If index is deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  
  Sample 'jsonSMIndex' JSON :
  
  {
  "id":0, "tableId":0, "name": "",
  "owner": "",
  "uniqueness": "",
  "sortOrder": "",
  "type": "",
  "ordinalPosition": 0
  }
  
  Since:
  
  8.2.1
- deleteIndexesByIds
  
  public String deleteIndexesByIds(String userName, String password, String outputFormat, String jsonArrayIndexId)
  
  Removes indexes for the specified list of index ids. Specifying index ids are mandatory.
  OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  jsonArrayIndexId - String
  
  Returns:
  
  String - If Indexes are deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  
  Since:
  
  8.2.1
- deleteIndexes
  
  public String deleteIndexes(String userName, String password, String outputFormat, String jsonArraySMIndex)
  
  Removes indexes for the specified list of SMIndex objects. Specifying index id in each SMIndex object is mandatory.
  OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  jsonArraySMIndex - String
  
  Returns:
  
  String - If Indexes are deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML 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
  }
  ]
  }
  ]
  
  Since:
  
  8.2.1
- deleteIndexesByNode
  
  public String deleteIndexesByNode(String userName, String password, String outputFormat, String nodeType, int nodeId)
  
  Removes indexes for the specified nodeId of nodeType.
  Specification of nodeId and nodeType are mandatory.
  nodeType can be either SM_TABLE or SM_COLUMN. Depending upon the nodeType, nodeId will be either columnId or tableId.
  If nodeType is SM_TABLE then all the associated indexes of the specified tableId are deleted or if nodeType is SM_COLUMN then all the associated indexes of the specified columnId are deleted.
  OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  nodeType - Node Object - valid types - SM_TABLE, SM_COLUMN
  
  nodeId - int
  
  Returns:
  
  String - If Indexes are deleted successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  
  Since:
  
  8.2.1
- getIndex
  
  public String getIndex(String userName, String password, String outputFormat, int indexId, int fillOptions)
  
  Returns SMIndex Object for the specified indexId in the specified outputFormat. Specifying the indexId is mandatory.
  The returned SMIndex Object contains all the details of SMIndex such as index name, type,owner..etc and also contains the list of column objects to which the index is assigned based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
  Here fillOptions parameter takes value of 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.
  OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  indexId - int
  
  fillOptions - APIConstants.SMFillOptions int
  
  Returns:
  
  String - SMIndex object in the form of JSON or XML String.
  
  Since:
  
  8.2.1
- getIndexByName
  
  public String getIndexByName(String userName, String password, String outputFormat, int tableId, String indexName, int fillOptions)
  
  Returns SMIndex Object for the specified tableId and indexName.Specifying the tableId and indexName are mandatory.
  The returned SMIndex object contains index name, type, owner..etc and also contains the list of column objects to which the index is assigned based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
  Here fillOptions parameter takes value of 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.
  
  OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  tableId - int
  
  indexName - String
  
  fillOptions - APIConstants.SMFillOptions int
  
  Returns:
  
  String - SMIndex object in the form of JSON or XML String.
  
  Since:
  
  8.2.1
- getIndexes
  
  public String getIndexes(String userName, String password, String outputFormat, int tableId, int fillOptions)
  
  Returns list of SMIndex Objects for the specified tableId. Specifying the tableId is mandatory.
  The returned SMIndex Objects contains all the details of SMIndex such as index name, type,owner..etc and also contains the list of column objects to which the index is assigned based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
  Here fillOptions parameter takes value of 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.
  OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  tableId - int
  
  fillOptions - APIConstants.SMFillOptions int
  
  Returns:
  
  String - SMIndex object in the form of JSON or XML String.
  
  Since:
  
  8.2.1
- getIndexesByNode
  
  public String getIndexesByNode(String userName, String password, String outputFormat, String nodeType, int nodeId, int fillOptions)
  
  Returns the list of SMIndex objects for the specified nodeId of nodeType.
  Each SMIndex object contains details like index name, type,owner..etc and also contains the list of column objects to which the index is assigned based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
  Here fillOptions parameter takes value of 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.
  Specification of nodeId and nodeType are mandatory,nodeType can be either SM_TABLE or SM_COLUMN. Depending upon the nodeType, nodeId will be either tableId or columnId.
  OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  nodeType - Node Object - valid types - SM_TABLE, SM_COLUMN
  
  nodeId - int
  
  fillOptions - APIConstants.SMFillOptions int
  
  Returns:
  
  String - SMIndex Object in the form of JSON or XML String.
  
  Since:
  
  8.2.1
- getIndexByNodeByName
  
  public String getIndexByNodeByName(String userName, String password, String outputFormat, String nodeType, int nodeId, String indexName, int fillOptions)
  
  Returns SMIndex object for the specified nodeId of nodeType and indexName.
  SMIndex object contains details like index name, type,owner..etc and also contains the list of column objects to which the index is assigned based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
  Here fillOptions parameter takes value of 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.
  Specification of nodeId and nodeType are mandatory,nodeType can be either SM_TABLE or SM_COLUMN. Depending upon the nodeType, nodeId will be either tableId or columnId.
  OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON String.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  nodeType - Node Object - valid types - SM_TABLE, SM_COLUMN
  
  nodeId - int
  
  indexName - String
  
  fillOptions - APIConstants.SMFillOptions int
  
  Returns:
  
  String - SMIndex Object in the form of JSON or XML String.
  
  Since:
  
  8.2.1
- publishTable
  
  public String publishTable(String userName, String password, String outputFormat, int tableId)
  
  Table is published for the specified tableId. specifying the tableId is mandatory.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String- Valid values: JSON or XML
  
  tableId - int
  
  Returns:
  
  String - If table is published successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  
  Since:
  
  8.3
- publishColumn
  
  public String publishColumn(String userName, String password, String outputFormat, int columnId)
  
  Column is published for the specified columnId. specifying the columnId is mandatory.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String- Valid values: JSON or XML
  
  columnId - int
  
  Returns:
  
  String - If table is published successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  
  Since:
  
  8.3
- publishNode
  
  public String publishNode(String userName, String password, String outputFormat, String nodeType, int nodeId)
  
  Node is published for the specified nodeId. Specifying the nodeId is mandatory. nodeType can be either SM_TABLE, SM_COLUMN. Depending upon the nodeType, nodeId will be either tableId or columnId.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  nodeId - int
  
  nodeType - String - valid Types are SM_TABLE, SM_COLUMN
  
  Returns:
  
  String - If node is published successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  
  Since:
  
  8.3
- publishTables
  
  public String publishTables(String userName, String password, String outputFormat, String tableIdsJsonArray)
  
  Tables are published for the specified tableIds, specifying the list of tableIds are mandatory.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  tableIdsJsonArray - String - List of tableIds
  
  Returns:
  
  String - If tables are published successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  
  Since:
  
  8.3
- publishColumns
  
  public String publishColumns(String userName, String password, String outputFormat, String columnIdsJsonArray)
  
  Columns are published for the specified columnIds, specifying the list of columnIds are mandatory.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  columnIdsJsonArray - String - List of columnIds
  
  Returns:
  
  String - If columns are published successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  
  Since:
  
  8.3
- publishNodes
  
  public String publishNodes(String userName, String password, String outputFormat, String nodeType, String nodeIdsJsonArray)
  
  Nodes are published for the specified nodeIds. Specifying the nodeIds are mandatory. nodeType can be either SM_TABLE, SM_COLUMN. Depending upon the nodeType, nodeIds will be either tableIds or columnIds.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  nodeType - String - Valid types: SM_TABLE, SM_COLUMN
  
  nodeIdsJsonArray - String - List of nodeIds
  
  Returns:
  
  String - If columns are published successfully, it will return RequestStatus Object consisting of Request success flag, status message and userObject etc... in the form of JSON or XML String.
  
  Since:
  
  8.3
- scanIntoEnvironment
  
  public String scanIntoEnvironment(String userName, String password, String outputFormat, int environmentId, String dbHelperJson, 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.
  outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON string.
  
  The following properties in the dbHelper object are mandatory:
  
  databaseType - This defines the type of the database to be scanned and saved. For values reference at DBProperties.DatabaseType. Depending on this value, mandatory values will vary from one database to other.
  
  If the databaseType value retrieved from the dbHelper Object is RDBMS database, then the environment is loaded and persisted into specified environment by specifying the dbUrl, dbDriver,dbUserName,dbPassword, dbName, dbSchema, databaseType, ipAddress, scanCriteria,readColumns,readComments,readTables, readViews, readSynonyms and selectedTables/selectedViews/selectedSynonyms etc.
  
  If the databaseType value retrieved from dbHelper object is file based database, then the environment is loaded and persisted into specified environment by specifying the filePath (i.e the location from which the file can be read), scanCriteria,readColumns, readComments, readTables, readViews,readSynonyms and selectedTables/selectedViews/selectedSynonyms etc.
  
  scanCriteria - This defines the selection criteria of objects(TABLES/VIEWS/SYNONYMS/COMPONENTS) 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/COMPONENTS. If the database contains nested tables, then need to specify the declarationPath for the nested tables.
  
  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.
  
  modelType & readLogicalColumns - These properties from the dbHelper object are used for only ERWIN file based databases.
  modelType defines the order in which the tables are displayed and readLogicalColumns value defines whether to skip logical columns or not.
  The value of modelType value can be either PHYSICAL OR LOGICAL (For values reference at DBHelper.ModelType)). DBHelper.ModelType default value is PHYSICAL.
  The value of readLogicalColumns accepts boolean value true or false.
  importSdi - This flag is used to import sensitive data for SQL Server, ORACLE and SNOWFLAKE databases. If it is sets to true, the sensitive information will be scanned.
  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.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  environmentId - int
  
  dbHelperJson - in json format
  
  dbOperation - String
  
  Returns:
  
  String - RequestStatus object in the form of JSON 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",
  "importSdi" : false,
  "modelType": "PHYSICAL", ==> (for erwin & json databases etc)
  "useReferenceId": false, ==> (for erwin & cwm databases)
  "supportAutoCommit": false ==>(for BigQuery database)
  }
  
  Since:
  
  9.0
- scanEnvironment
  
  public String scanEnvironment(String userName, String password, String outputFormat, String dbHelperObjJson)
  
  Loads an Environment for the specified dbHelper Object. Specifying the dbHelper object in the form of json is mandatory.
  outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON string.
  
  The following properties in the dbHelper object are mandatory:
  
  databaseType - This defines the type of the database to be scanned and saved. For values reference at DBProperties.DatabaseType. Depending on this value, mandatory values will vary from one database to other.
  
  If the databaseType value retrieved from dbHelper Object is RDBMS database, then the environment is loaded by specifying the dbUrl, dbDriver,dbUserName,dbPassword, dbName, dbSchema, databaseType, ipAddress, scanCriteria,readColumns,readComments,readTables, readViews, readSynonyms and selectedTables/selectedViews/selectedSynonyms.
  
  If the databaseType value retrieved from dbHelper Object is file based database, then the environment is loaded by specifying the filePath i.e the location from which the file can be read, scanCriteria,readColumns, readComments, readTables, readViews,readSynonyms and selectedTables/selectedViews/selectedSynonyms.
  
  scanCriteria - This defines the selection criteria of objects(TABLES/VIEWS/SYNONYMS/COMPONENTS) 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/COMPONENTS.
  
  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.
  
  modelType & readLogicalColumns - These properties from the dbHelper object are used for only ERWIN file based databases.
  modelType defines the order in which the tables are displayed and readLogicalColumns value defines whether to skip logical columns or not.
  The value of modelType value can be either PHYSICAL OR LOGICAL (For values reference at DBHelper.ModelType)). DBHelper.ModelType 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.
  
  Parameters:
  
  dbHelperObjJson - in json format
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - DBEnvironment object in the form of JSON String.
  
  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", "modelType": "PHYSICAL", ==> (for erwin & json databases etc)
  "useReferenceId": false ==> (for erwin & cwm databases)
  }
  
  Since:
  
  9.0
- importEnvironment
  
  public String importEnvironment(String userName, String password, String outputFormat, int environmentId, String dbHelperObjJson, String dbOperation, String fileExtension)
  
  Imports the environment on the specified environmentId. Specifying the filePath and filePathType in dbHelper object and dbOperation is mandatory. Here the file in filePath provided should be in xml/zip/amp formats only.
  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).
  outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON string.
  
  Parameters:
  
  userName - - String
  
  password - - String
  
  environmentId - - int
  
  dbHelperObjJson - - String in json format
  
  dbOperation - - String
  
  fileExtension - - String - Valid Types XML, AMP, ZIP.
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  - String - RequestStatus object in the form of json string
  Sample 'dbHelperObjJson' JSON :
  {
  "filePath":"",
  "filePathType":"ABSOLUTE",
  "updateTableELNFlag":false,
  "updateColumnELNFlag":false,
  "generateSummary":false,
  "validateData": false,
  "importTags":false,
  "importAssociations":false
  }
  
  Since:
  
  9.5
- exportEnvironment
  
  public String exportEnvironment(String userName, String password, String outputFormat, int environmentId, String fileExtension)
  
  Environment is exported to xml for the specified environmentId.
  The exported filePath will be availabale in the userObject of RequestStatus Object and this will be RELATIVE path.
  outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON string.
  
  Parameters:
  
  userName - - String
  
  password - - String
  
  outputFormat - String - Valid values: JSON or XML
  
  environmentId - - int
  
  fileExtension - String - Valid Types XML, AMP, ZIP.
  
  Returns:
  
  - String - RequestStatus object in the form of json string
  
  Since:
  
  9.5
- versionEnvironment
  
  public String versionEnvironment(String userName, String password, String outputFormat, int environmentId, String changeDescription, String versionLabel)
  
  Versions the environment for the specified environmentId. Creates a copy of entire metadata in archived environments with new environment Id and passive state, versioning will include extended properties, valid values, SDI fields and documents.
  Specifying the environmentId and changeDescription are mandatory, outputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON string.
  
  Parameters:
  
  userName - - String
  
  password - - String
  
  environmentId - - int
  
  changeDescription - - String
  
  versionLabel - - String
  
  outputFormat - String - Valid values: JSON or XML
  
  Returns:
  
  String - RequestStatus object in the form of json string
  
  Since:
  
  10.0
- deleteEnvironmentById
  
  public String deleteEnvironmentById(String userName, String password, String outputFormat, int environmentId, String versionMode)
  
  Deletes the environment with the specified environmentId and versionMode. Specifying the environmentId is mandatory to delete a particular environment. If versionMode is not specified current version environment will be deleted.
  Version mode has values ALL_VERSIONS, CURRENT_VERSION.
  ALL_VERSIONS - Deletes all environments.
  CURRENT_VERSION - Deletes the present/current version.
  If the environment is deleted all its associated data will also be deleted.
  OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON string.
  
  Parameters:
  
  userName - - String
  
  password - - String
  
  outputFormat - - String - Valid values: JSON or XML
  
  environmentId - - int
  
  versionMode -
  
  Returns:
  
  String - RequestStatus object in the form of JSON string
  
  Since:
  
  12.1
- deleteTables
  
  public String deleteTables(String userName, String password, String outputFormat, String tableIdsJsonArray)
  
  Deletes the tables with the specified list of tableIds. Specifying the tableIds list is mandatory.
  If tables are deleted all its associated data will also be deleted.
  OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON string.
  
  Parameters:
  
  userName - - String
  
  password - - String
  
  outputFormat - - String - Valid values: JSON or XML
  
  tableIdsJsonArray -
  
  Returns:
  
  String - RequestStatus object in the form of JSON string
  
  Since:
  
  12.1
- deleteTablesByEnvironmentId
  
  public String deleteTablesByEnvironmentId(String userName, String password, String outputFormat, int environmentId)
  
  Deletes the list of tables for the given environmentId. Specifying the environmentId is mandatory to delete tables.
  If the tables are deleted all its associated data will also be deleted.
  OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON string.
  
  Parameters:
  
  userName - - String
  
  password - - String
  
  outputFormat - - String - Valid values: JSON or XML
  
  environmentId - - int
  
  Returns:
  
  String - RequestStatus object in the form of JSON string
  
  Since:
  
  12.1
- exportDataDictionary
  
  public String exportDataDictionary(String userName, String password, String outputFormat, int objectId, int objectTypeId, int fillOptions)
  
  Environment or table is exported to xlsx format for the specified objectId and objectTypeId. Specifying the objectId and objectTypeId are mandatory.
  ObjectTypeId can be either SM_ENVIRONMENT id or SM_TABLE id Depending upon the objectTypeId, objectId will be either environmentId or tableId.
  The exported filePath will be available in the userObject of requestStatus object. The filePath in the userObject is RELATIVE.
  OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON string.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  objectId - int
  
  objectTypeId - int
  
  fillOptions - APIConstants.SMFillOptions int
  
  Returns:
  
  String - RequestStatus object in the form of JSON string
  
  Since:
  
  12.1
- importDataDictionary
  
  public String importDataDictionary(String userName, String password, String outputFormat, int environmentId, String ImportHelper)
  
  Imports the tables on the specified environmentId. Specifying the filePath and filePathType are mandatory in importHelper object. The supported values for the filePathType are ABSOLUTE, RELATIVE. Here the the file in filePath given must be in xlsx or xls format only.
  Specifying the environmentId is mandatory.
  OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON string.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  environmentId - int
  
  ImportHelper - ImportHelper
  
  Returns:
  
  String - RequestStatus object in the form of JSON string
  
  Since:
  
  12.1
- getMetaData
  
  public String getMetaData(String userName, String password, String outputFormat, String inputJson)
  
  Returns the metadata information includes systemId, systemName, environmentId, environmentName, environemnetType, dataSourceType etc..as a JSONArray for the specified input values in the JSON object.
  The valid values in the input json object are SERVER, DATABASE, SCHEMA AND TABLENAME.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XML
  
  inputJson - String
  
  Returns:
  
  String - RequestStatus object in the form of JSON string
  Sample JSON :
  
  {
  "SERVER":"",
  "DATABASE":"",
  "SCHEMA":"",
  "TABLENAME":""
  }
  
  Since:
  
  12.1
- getEnvironmentWithFillOptions
  
  public String getEnvironmentWithFillOptions(String userName, String password, String outputFormat, int environmentId, int fillOptions, boolean useReferenceId)
  
  Returns SMEnvironment object for the specified environmentId, fillOptions, and useReferenceId. Specifying the environmentId,fillOptions and useReferenceId is mandatory.
  Returns all the details pertaining to a specific environment such as environmentName, systemName in which environment is present, related DB information and its auditHistory. Specifying the environmentId is mandatory in order to retrieve the environment details.
  useReferenceId takes the values as true or false.
  If useReferenceId is true, then it returns the environment based on checking the table referenceId which is set to the tables and column referenceId set in the columns of those tables in the specific environment.
  Here fillOptions parameter takes value of APIConstants.SMFillOptions.ENVIRONMENT_TABLES_COLUMNS Based on the value passed its related data is returned within the SMEnvironment object. The default integer value for fillOptions is 0(zero).
  OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON string.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XMLs
  
  environmentId - int
  
  fillOptions - int APIConstants.SMFillOptions
  
  useReferenceId - boolean
  
  Returns:
  
  String
  
  Since:
  
  12.1
- getTablesWithFillOptions
  
  public String getTablesWithFillOptions(String userName, String password, String outputFormat, String tableIds, int fillOptions)
  
  Returns the list of SMTable objects for the specified list of tableIds along with fillOptions value.
  Each returned SMTable object contains all the details pertaining to table such as table name, table definition, environment name in which table is present etc...and also contains details of table indexes, all associated table columns and table extended properties based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
  Here fillOptions can be Integer values of either 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)).
  Specifying the tableIds and fillOptions are mandatory in order to fetch the table details.
  OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON string.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XMLs
  
  tableIds - String
  
  fillOptions - int APIConstants.SMFillOptions
  
  Returns:
  
  String - List of SMTable objects in the form of JSON or XML String.
  
  Since:
  
  13.0
- getColumnsWithFillOptions
  
  public String getColumnsWithFillOptions(String userName, String password, String outputFormat, String columnIds, int fillOptions)
  
  Returns the list of SMColumn objects for the specified list of columnIds along with fillOptions value.
  Specifying the columnIds and fillOptions are mandatory. Each returned SMColumn object contains all the details pertaining to column such as column name, table name in which the column is present, column length, column precision etc... and also contains details of column indexes, column extended properties ,valid values and extended properties of valid values based on the fillOptions parameter value passed with reference/addition of APIConstants.SMFillOptions.
  Here fillOptions parameter takes value of either 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.
  OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON string.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String - Valid values: JSON or XMLs
  
  columnIds - String
  
  fillOptions - int APIConstants.SMFillOptions
  
  Returns:
  
  String - List of SMColumn objects in the form of JSON or XML String.
  
  Since:
  
  13.0
- addSDIClassifications
  
  public String addSDIClassifications(String userName, String password, String outputFormat, String nodeType, String objectIdsListOfSDIClassificationsJson)
  
  This function is used to insert a list of SDI classifications for the specified nodeType. NodeIds (objectIds) must be given along with SDI's list. We can add multiple classifications to a single node ID.
  OutputFormat can be either JSON or XML. If outputFormat is not specified, by default the method will return the JSON string.
  
  Parameters:
  
  userName - String
  
  password - String
  
  outputFormat - String
  
  nodeType - String
  
  objectIdsListOfSDIClassificationsJson - String
  
  Returns:
  
  String - List of SMColumn objects in the form of JSON or XML
  Sample 'SDIClassificationsjsonlist' JSON : {
  "1":[
  {
  "objectTypeId": "",
  "name": "",
  "description": "",
  "id": "",
  "objectId":""
  },
  {
  "objectTypeId": "",
  "name": "",
  "description": "",
  "id":"" ,
  "objectId":""
  }
  ],
  "2":[
  {
  "objectTypeId": "",
  "name": "",
  "description": "",
  "id": "",
  "objectId":""
  },
  {
  "objectTypeId": "",
  "name": "",
  "description": "",
  "id":"" ,
  "objectId":""
  }
  ]
  }

Class SystemManagerService

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

SystemManagerService

Method Details

createSystem

getSystems

getSystem

getSystemById

getSystemDocuments

getSystemId

updateSystem

deleteSystem

createEnvironment

getEnvironments

getEnvironment

getEnvironmentByName

getEnvironmentConnectionProperties

getEnvironmentId

getEnvironmentIdByName

updateEnvironmentDetails

deleteEnvironment

loadEnvironmentMetadata

loadEnvironmentMetadataById

updateEnvironmentMetadata

createTable

getTable

getTableByName

getTableId

getTableIdByName

getTables

updateTable

deleteTable

createColumn

getColumn

getColumnByName

getColumnId

getColumnIdByBreadcrumb

getColumns

updateColumn

deleteColumn

addDocument

addDocumentWithNodeName

deleteDocuments

deleteDocumentsByNodeName

deleteSystemDocuments

deleteSystemDocumentsBySystemName

deleteEnvironmentDocumentsById

deleteEnvironmentDocuments

deleteDocumentById

getDocumentById

getDocumentsByIds

getEnvironmentDocuments

deleteDocumentsByIds

updateDocument

cloneEnvironment

cloneEnvironmentBySystemId

cloneEnvironmentById

getEnvironmentById

getColumnById

getColumnsById

getIndexColumns

addIndex

addIndexByColumnId

addIndexes

addIndexesByColumnId

updateIndex

updateIndexes

deleteIndexById

deleteIndex

deleteIndexesByIds

deleteIndexes

deleteIndexesByNode

getIndex

getIndexByName

getIndexes

getIndexesByNode

getIndexByNodeByName