RelaticsAPI
All operations need the following parameters:
EnvironmentID:ID of the Environment
WorkspaceID:ID of the Workspace
The following operations are supported. For a formal definition, please review the Service Description.
-
CloneInstanceElement
Clone an instance element
InstanceElement: ID or Name of the instance element -
CreateInstanceElement
Add an instance element of the specified type element
TypeElement: ID or Name of the type element -
CreateInstanceRelation
Creates an instance relation between the specified objects
R1:ID of the r1 object
R2: ID of the r2 object
Relation: Rootref of the new relation -
CreateLibraryElement
Add a library element to the specified library element
LibraryElement: ID or Name of the library element -
CreateLibraryProperty
Creates the property for a specified library element
LibraryElement: ID of the library element
Property:RoleOfRef of the new property. Leave empty ("") for default property. -
CreateLibraryRelation
Creates a library relation between the specified objects
R1:ID of the r1 object
R2: ID of the r2 object
Relation:RoleOfRef of the new relation. Leave empty ("") for the default relation -
CreateTypeElement
Add a type element to the specified library element
LibraryElement: ID or Name of the library element -
CreateTypeProperty
Creates a type property for the specified type element
TypeElement: ID of the type element
Property: RoleOfRef of the new property. Leave empty ("") for the default property. -
CreateTypeRelation
Creates a type relation between the specified objects
R1:ID of the r1 object
R2: ID of the r2 object
Relation:RoleOfRef of the new relation. Leave empty ("") for the default relation -
DeleteInstanceElement
Delete an instance element
InstanceElement: ID or Name of the instance element -
DeleteInstanceRelation
Delete an instance relation
InstanceRelation: ID or Name of the instance relation -
DeleteLibraryElement
Delete a library element
LibraryElement: ID or Name of the library element -
DeleteLibraryProperty
Delete a library property
LibraryProperty: ID or Name of the library property -
DeleteLibraryRelation
Delete a library relation
LibraryRelation: ID or Name of the library relation -
DeleteTypeElement
Delete a type element
TypeElement: ID or Name of the type element -
DeleteTypeProperty
Delete a type property
TypeProperty: ID or Name of the type property -
DeleteTypeRelation
Delete a type relation
TypeRelation: ID or Name of the type relation -
GetInstanceElement
Gets the specified instance element
InstanceElement:ID of the instance element to be found -
GetInstanceElementByForeignKey
Gets the specified instance element
ForeignKey:ForeignKey of the instance element to be found
TypeElement:ConfigurationOfRef of the instance element to be found -
GetInstanceProperty
Gets the specified property of a specified instance element
InstanceElement:The ID of the instance element where the property belongs to
Property:Name or RootRef of the instance property. -
GetInstanceRelation
Gets the specified relation of an instance element
R1:ID of the r1 object
R2:ID of the r2 object
Relation:RootRef of the relation -
GetLibraryElement
Gets the specified library element
LibraryElement:ID of the library element to be found -
GetLibraryProperty
Gets the specified property of a specified library element
LibraryElement:The ID of the library element where the property belongs to
Property:Name or RootRef of the property -
GetLibraryRelation
Gets the specified relation of a library element
R1:ID of the r1 object
R2:ID of the r2 object
Relation:RootRef of the relation -
GetTypeElement
Gets the specified type element
TypeElement:ID of the type element to be found -
GetTypeProperty
Gets the specified property of a specified type element
TypeElement:The ID of the type element where the property belongs to
Property:Name or RootRef of the type property -
GetTypeRelation
Gets the specified relation of a type element
R1:ID of the r1 object
R2:ID of the r2 object
Relation:RootRef of the relation -
ResetParameterValues
Reset all parametervalues
BuildingBlock:The id or name of the buildingblock that contains the parameters
ObjectID:ID of the object
-
SendMail
Send a mail
To:To email adresses, comma-seperated
Subject:Subject of the mail
BodyBody of the email -
SendMailAdvanced
Send a mail
To:To email adresses, comma-seperated
CC:CC email adresses, comma-seperated
BCC:BCC email adresses, comma-seperated
Subject:Subject of the mail
BodyBody of the email -
SetParameterValue
Set a parametervalue
BuildingBlock:The id or the buildingblockname of the buildingblock that contains the parameter
Parameter:The name or id of the parameter
ParameterValue:The value of the parameter
ObjectID:ID of the object
-
UpdateInstanceElement
Update an attribute on the specified instance element
InstanceElement:ID of the instance element that needs to be updated
Attribute:Name of the attribute
AttributeValue:New value of the attribute -
UpdateInstanceProperty
Update an attribute on the specified type property
InstanceProperty:ID of the instance property that needs to be updated
Attribute:Name of the attribute
AttributeValue:New value of the attribute -
UpdateInstanceRelation
Update an attribute of the specified instance relation
InstanceRelation:ID of the instance relation that needs to be updated
Attribute:Name of the attribute
AttributeValue:New value of the attribute -
UpdateLibraryElement
Update an attribute on the specified library element
LibraryElement:ID of the library element that needs to be updated
Attribute:Name of the attribute
AttributeValue:New value of the attribute -
UpdateLibraryProperty
Update an attribute on the specified libary property
LibraryProperty:ID of the library property that needs to be updated
Attribute:Name of the attribute
AttributeValue:New value of the attribute -
UpdateLibraryRelation
Update an attribute of the specified library relation
LibraryRelation:ID of the library relation that needs to be updated
Attribute:Name of the attribute
AttributeValue:New value of the attribute -
UpdateTypeElement
Update an attribute on the specified type element
TypeElement:ID of the type element that needs to be updated
Attribute:Name of the attribute
AttributeValue:New value of the attribute -
UpdateTypeProperty
Update an attribute on the specified instance property
TypeProperty:ID of the type property that needs to be updated
Attribute:Name of the attribute
AttributeValue:New value of the attribute -
UpdateTypeRelation
Update an attribute of the specified type relation
TypeRelation:ID of the type relation that needs to be updated
Attribute:Name of the attribute
AttributeValue:New value of the attribute