Repository.XFRACAS.ImportXFRACASXMLString: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 10: Line 10:
''entityID''
''entityID''


:Integer. The ID number of the XFRACAS entity to import the data into. (Required)
:Required. Integer. The ID number of the XFRACAS entity to import the data into.


''importType''
''importType''


:The type of XFRACAS element (e.g., incident, problem, etc.) to import. Can be any [[XFRACASImportType Enumeration|XFRACASImportType]] constant. (Required)
:Required. The type of XFRACAS element (e.g., incident, problem, etc.) to import. Can be any [[XFRACASImportType Enumeration|XFRACASImportType]] constant.


''xmlString''
''xmlString''


:String. The string consisting of the XML to import.
:Required. String. The string consisting of the XML to import.


''fileTitle''
''fileTitle''


:String. The file title of the XML file byte array to import.
:Required. String. The file title of the XML file byte array to import.


''fileDescription''
''fileDescription''


: String. A description of the XML data to import. (Required)
:Required. String. A description of the XML data to import.





Revision as of 16:29, 25 August 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Uploads an import file byte stream for processing. Returns an Integer that represents the system ID.

Syntax

.XFRACAS.ImportXFRACASXMLString(entityID, importType, xmlString, fileTitle, fileDescription)

Parameters

entityID

Required. Integer. The ID number of the XFRACAS entity to import the data into.

importType

Required. The type of XFRACAS element (e.g., incident, problem, etc.) to import. Can be any XFRACASImportType constant.

xmlString

Required. String. The string consisting of the XML to import.

fileTitle

Required. String. The file title of the XML file byte array to import.

fileDescription

Required. String. A description of the XML data to import.


Example

This example assumes that the repository is connected to an XFRACAS with existing entities.

VB.NET

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  ... 

 'Define an XML string and populate it with the XML text. 
 Dim xmlString As String = Nothing
  ... 


 'Import the XML byte array into the first available XFRACAS entity. 
 'The following code assumes that the XML string type describes XFRACAS incidents. 
 DimImportXMLSystemIDAs Integer
 ImportXMLSystemID = MyRepository.XFRACAS.ImportXFRACASXMLString(1, XFRACASImportType.Incident, xmlString, "XMLFileTitle", "XMLFileDescription")