APISynthesisResourcesTutorial - Revision history

Kate Racaza: Redirected page to API Tutorials

2016-02-09T22:14:37Z

Kate Racaza: Undo revision 61204 by Kate Racaza (Talk)

2015-10-30T18:29:38Z

Undo revision 61204 by Kate Racaza (Talk)

← Older revision		Revision as of 18:29, 30 October 2015
Line 12:		Line 12:
	This four-part tutorial introduces you to the basic functionalities of the Synthesis API. You will learn how to use the API to connect to a Synthesis repository, create a new resource, update an existing resource and obtain calculated results from a model.		This four-part tutorial introduces you to the basic functionalities of the Synthesis API. You will learn how to use the API to connect to a Synthesis repository, create a new resource, update an existing resource and obtain calculated results from a model.

			Note that this tutorial makes use of object IDs to help you test responses from the API. We recommend reading [[Using Object IDs\|this short topic]] on object IDs before you begin.

Kate Racaza at 18:20, 30 October 2015

2015-10-30T18:20:50Z

← Older revision		Revision as of 18:20, 30 October 2015
Line 12:		Line 12:
	This four-part tutorial introduces you to the basic functionalities of the Synthesis API. You will learn how to use the API to connect to a Synthesis repository, create a new resource, update an existing resource and obtain calculated results from a model.		This four-part tutorial introduces you to the basic functionalities of the Synthesis API. You will learn how to use the API to connect to a Synthesis repository, create a new resource, update an existing resource and obtain calculated results from a model.

	~~Note that this tutorial makes use of object IDs to help you test responses from the API. We recommend reading [[Using Object IDs\|this short topic]] on object IDs before you begin.~~

Kate Racaza at 18:18, 30 October 2015

2015-10-30T18:18:29Z

← Older revision		Revision as of 18:18, 30 October 2015
Line 12:		Line 12:
	This four-part tutorial introduces you to the basic functionalities of the Synthesis API. You will learn how to use the API to connect to a Synthesis repository, create a new resource, update an existing resource and obtain calculated results from a model.		This four-part tutorial introduces you to the basic functionalities of the Synthesis API. You will learn how to use the API to connect to a Synthesis repository, create a new resource, update an existing resource and obtain calculated results from a model.

	Note that this tutorial makes use of object IDs to help you test responses from the API. We recommend reading [[Using ~~Item~~ IDs\|this short topic]] on object IDs before you begin.		Note that this tutorial makes use of object IDs to help you test responses from the API. We recommend reading [[Using Object IDs\|this short topic]] on object IDs before you begin.

Kate Racaza at 17:26, 30 October 2015

2015-10-30T17:26:32Z

← Older revision		Revision as of 17:26, 30 October 2015
Line 12:		Line 12:
	This four-part tutorial introduces you to the basic functionalities of the Synthesis API. You will learn how to use the API to connect to a Synthesis repository, create a new resource, update an existing resource and obtain calculated results from a model.		This four-part tutorial introduces you to the basic functionalities of the Synthesis API. You will learn how to use the API to connect to a Synthesis repository, create a new resource, update an existing resource and obtain calculated results from a model.

	Note that this tutorial makes use of ~~item~~ IDs to help you test responses from the API. We recommend reading [[Using Item IDs\|this short topic]] on ~~item~~ IDs before you begin.		Note that this tutorial makes use of object IDs to help you test responses from the API. We recommend reading [[Using Item IDs\|this short topic]] on object IDs before you begin.

Kate Racaza at 17:14, 30 October 2015

2015-10-30T17:14:07Z

← Older revision		Revision as of 17:14, 30 October 2015
Line 12:		Line 12:
	This four-part tutorial introduces you to the basic functionalities of the Synthesis API. You will learn how to use the API to connect to a Synthesis repository, create a new resource, update an existing resource and obtain calculated results from a model.		This four-part tutorial introduces you to the basic functionalities of the Synthesis API. You will learn how to use the API to connect to a Synthesis repository, create a new resource, update an existing resource and obtain calculated results from a model.

	Note that this tutorial makes use of ~~database/record~~ IDs to help you test the ~~response of the method calls~~. We recommend reading [[Using ~~Database and Record~~ IDs\|this short topic]] on ~~database~~ IDs before you begin.		Note that this tutorial makes use of item IDs to help you test responses from the API. We recommend reading [[Using Item IDs\|this short topic]] on item IDs before you begin.

Kate Racaza at 16:43, 30 October 2015

2015-10-30T16:43:11Z

← Older revision		Revision as of 16:43, 30 October 2015
Line 12:		Line 12:
	This four-part tutorial introduces you to the basic functionalities of the Synthesis API. You will learn how to use the API to connect to a Synthesis repository, create a new resource, update an existing resource and obtain calculated results from a model.		This four-part tutorial introduces you to the basic functionalities of the Synthesis API. You will learn how to use the API to connect to a Synthesis repository, create a new resource, update an existing resource and obtain calculated results from a model.

			Note that this tutorial makes use of database/record IDs to help you test the response of the method calls. We recommend reading [[Using Database and Record IDs\|this short topic]] on database IDs before you begin.


	The Synthesis Platform uses repositories to store projects and analysis data. Projects, in turn, hold resources that contain various types of information that can be shared between analyses. Therefore, to create or update a resource in a Synthesis repository, we must begin by first connecting to the repository and then accessing the project that holds that resource.		The Synthesis Platform uses repositories to store projects and analysis data. Projects, in turn, hold resources that contain various types of information that can be shared between analyses. Therefore, to create or update a resource in a Synthesis repository, we must begin by first connecting to the repository and then accessing the project that holds that resource.


	==Part 1: Connect to a Synthesis Repository and Project==		==Part 1: Connect to a Synthesis Repository and Project==

Kate Racaza at 22:53, 29 October 2015

2015-10-29T22:53:08Z

← Older revision		Revision as of 22:53, 29 October 2015
Line 66:		Line 66:
	Let’s verify that our connections to the repository and project work.		Let’s verify that our connections to the repository and project work.

	Below is the code ~~list~~ for this example. On the Debug menu, click '''Start''' to run the application. A message box displays the name and ID number of the current project in the repository.		Below are the VBA and VB.NET code lists for this example. On the Debug menu, click '''Start''' to run the application. A message box displays the name and ID number of the current project in the repository.

	'''VBA'''		'''VBA'''

Kate Racaza at 18:13, 28 October 2015

2015-10-28T18:13:40Z

Kate Racaza at 18:05, 28 October 2015

2015-10-28T18:05:48Z

@@ Line 68: / Line 68: @@
 Below is the code list for this example. On the Debug menu, click '''Start''' to run the application. A message box displays the name and ID number of the current project in the repository.
-  '''VBA|VB.NET'''
+  '''VBA'''
   Sub Main()
@@ Line 100: / Line 100: @@
   End Sub
 ===References===

← Older revision		Revision as of 18:13, 28 October 2015
Line 105:		Line 105:
	{{APIPrefix\|Imports}} SynthesisAPI		{{APIPrefix\|Imports}} SynthesisAPI

	{{APIPrefix\|Public Class}} Form1		{{APIPrefix\|Public Class}} Form1
	{{APIPrefix\|Private Sub}} Button1_Click(sender {{APIPrefix\|As}} System.Object, e {{APIPrefix\|As}} System.EventArgs) {{APIPrefix\|Handles}} Button1.Click		{{APIPrefix\|Private Sub}} Button1_Click(sender {{APIPrefix\|As}} System.Object, e {{APIPrefix\|As}} System.EventArgs) {{APIPrefix\|Handles}} Button1.Click

	{{APIComment\|'Declare a new instance of the Repository class.}}		{{APIComment\|'Declare a new instance of the Repository class.}}
	{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository

	{{APIComment\|'Specify the full path to the Synthesis repository.}}		{{APIComment\|'Specify the full path to the Synthesis repository.}}
	{{APIComment\|'The following code assumes that a standard repository called "RSRepository1.rsr10" exists in the C drive.}}		{{APIComment\|'The following code assumes that a standard repository called "RSRepository1.rsr10" exists in the C drive.}}
	MyRepository.ConnectToRepository({{APIString\|"C:\RSRepository1.rsr10"}})		MyRepository.ConnectToRepository({{APIString\|"C:\RSRepository1.rsr10"}})

	{{APIComment\|'Declare a new instance of the NameIdPair class.}}		{{APIComment\|'Declare a new instance of the NameIdPair class.}}
	{{APIPrefix\|Dim}} ListofProjects() {{APIPrefix\|As}} NameIdPair		{{APIPrefix\|Dim}} ListofProjects() {{APIPrefix\|As}} NameIdPair

	{{APIComment\|'Get a list of all projects in the repository.}}		{{APIComment\|'Get a list of all projects in the repository.}}
	ListOfProjects = MyRepository.Project.GetAllProjects		ListOfProjects = MyRepository.Project.GetAllProjects

	{{APIComment\|'Set the first available project as the current project.}}		{{APIComment\|'Set the first available project as the current project.}}
	MyRepository.Project.SetCurrentProject(ListofProjects(0).ID)		MyRepository.Project.SetCurrentProject(ListofProjects(0).ID)

	{{APIComment\|'Display the name and ID number of the current project.}}		{{APIComment\|'Display the name and ID number of the current project.}}
	{{APIPrefix\|Dim}} ProjectName {{APIPrefix\|As}} String		{{APIPrefix\|Dim}} ProjectName {{APIPrefix\|As}} String
	{{APIPrefix\|Dim}} ProjectID {{APIPrefix\|As}} Integer		{{APIPrefix\|Dim}} ProjectID {{APIPrefix\|As}} Integer

	ProjectName = MyRepository.Project.GetCurrentProject.Name		ProjectName = MyRepository.Project.GetCurrentProject.Name
	ProjectID = MyRepository.Project.GetCurrentProject.ID		ProjectID = MyRepository.Project.GetCurrentProject.ID
	MsgBox ({{APIString\|"You are currently connected to: "}} & ProjectName & {{APIString\|", ID#"}} & ProjectID)		MsgBox ({{APIString\|"You are currently connected to: "}} & ProjectName & {{APIString\|", ID#"}} & ProjectID)

	{{APIComment\|'Disconnect from the Synthesis repository.}}		{{APIComment\|'Disconnect from the Synthesis repository.}}
	MyRepository.DisconnectFromRepository		MyRepository.DisconnectFromRepository

	{{APIPrefix\|End Sub}}		{{APIPrefix\|End Sub}}
	{{APIPrefix\|End Class}}		{{APIPrefix\|End Class}}