Repository.Model.UpdateModel: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) No edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
{{Template:APIBreadcrumb|10|Repository}} | <noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|Repository}}</noinclude> | ||
Saves all updates to a model. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update. | Saves all updates to a model. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update. | ||
Note that you can apply updates only to models that were created manually (i.e., models that were published from analyses cannot be updated via the API). | Note that you can apply updates only to models that were created manually (i.e., models that were published from analyses cannot be updated via the API). | ||
<noinclude> | |||
== Syntax == | == Syntax == | ||
''object''.'''Model.UpdateModel(''m'')''' | ''object''.'''Model.UpdateModel(''m'')''' | ||
| Line 13: | Line 13: | ||
{| {{APITable}} | {| {{APITable}} | ||
|- | |- | ||
|m{{APIParam|Required}}||The | |m{{APIParam|Required}}||The [[CModel Class|cModel]] object to be updated. | ||
|} | |} | ||
| Line 30: | Line 30: | ||
{{APIPrefix|Set}} AModel = MyRepository.Model.GetModel(47) | {{APIPrefix|Set}} AModel = MyRepository.Model.GetModel(47) | ||
{{APIComment|'Change the model's name to "New_Name" | {{APIComment|'Change the model's name to "New_Name."}} | ||
AModel.Name = "New_Name" | AModel.Name = {{APIString|"New_Name"}} | ||
{{APIComment|'Apply the update to the model. Changes will be reflected in the repository.}} | {{APIComment|'Apply the update to the model. Changes will be reflected in the repository.}} | ||
| Line 46: | Line 46: | ||
AModel = MyRepository.Model.GetModel(47) | AModel = MyRepository.Model.GetModel(47) | ||
{{APIComment|'Change the model's name to "New_Name" | {{APIComment|'Change the model's name to "New_Name."}} | ||
AModel.Name = "New_Name" | AModel.Name = {{APIString|"New_Name"}} | ||
{{APIComment|'Apply the update to the model. Changes will be reflected in the repository.}} | {{APIComment|'Apply the update to the model. Changes will be reflected in the repository.}} | ||
MyRepository.Model.UpdateModel(AModel) | MyRepository.Model.UpdateModel(AModel) | ||
</noinclude> | |||
Revision as of 21:51, 16 July 2015
 |
Member of: SynthesisAPI10Repository
Saves all updates to a model. Changes are reflected in the repository immediately upon refresh. Returns a Boolean value; when true, indicates a successful update.
Note that you can apply updates only to models that were created manually (i.e., models that were published from analyses cannot be updated via the API).
Syntax
object.Model.UpdateModel(m)
where object is a variable that represents a Repository object.
Parameters
| Name | Description | |
|---|---|---|
| mborder="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse; text-align: left; cellborder" | ||
| Name | Status | The cModel object to be updated. |
Example
This example assumes that a model with ID#47 exists in the repository.
VBA Dim MyRepository As New Repository ...'Add code to connect to a Synthesis repository. 'Get model #47 from project #1. Dim AModel As cModel MyRepository.Project.SetCurrentProject(1) Set AModel = MyRepository.Model.GetModel(47) 'Change the model's name to "New_Name." AModel.Name = "New_Name" 'Apply the update to the model. Changes will be reflected in the repository. Call MyRepository.Model.UpdateModel(AModel)
VB.NET Dim MyRepository As New Repository ...'Add code to connect to a Synthesis repository. 'Get model #47 from project #1. Dim AModel As cModel MyRepository.Project.SetCurrentProject(1) AModel = MyRepository.Model.GetModel(47) 'Change the model's name to "New_Name." AModel.Name = "New_Name" 'Apply the update to the model. Changes will be reflected in the repository. MyRepository.Model.UpdateModel(AModel)