virtual_source

The virtual_source command creates and deletes virtual sources, and also updates and retrieves the properties of a virtual source. Virtual sources are used to associate source objects to virtual objects.

The following tables lists the properties of a virtual source, describes each of them, and specifies whether each property is applicable in an HTTP POST or PUT method (as an input), or in an HTTP GET method (as an output). The properties differ depending on whether the virtual object is a virtual cube or a different virtual object.

Table 1. Virtual source properties (for a virtual cube) for input and output methods
Name	Description	HTTP methods
`parent`	`id` of the virtual cube that uses this virtual source.	`POST`
`name`	Name. This is an optional property. If it is omitted, `sourceName` is used. Localized text.	`POST GET PUT`
`sourceName`	Name of the source cube. Required for objects retrieved from the content store.	`POST GET`
`sourceObject`	`id` of the source cube. Required for objects retrieved from within the model.	`POST GET`
`sourcePath`	Path of the source cube. Required for objects retrieved from the content store.	`POST GET`

Table 2. Virtual source properties (for a virtual object other than a virtual cube) for input and output methods
Name	Description	HTTP methods
`parent`	`id` of the virtual object that uses this virtual source.	`POST`
`name`	Name. This is an optional property. If it is omitted, `sourceName` is used. Localized text.	`POST GET PUT`
`sourceName`	Name of the source object.	`GET`
`sourceObject`	`id` of the source object.	`POST GET`
`sourceParent`	`id` of the parent object of `sourceObject`.	`POST GET`