Cyscom Software-as-a-Service Application Platform Web Services Guide

Introduction

    Cyscom Software-as-a-Service application platform provides a set of xml web services for the purpose of integration with other applications. These web services provide both read and write access to Software-as-a-Service application data allowing to implement different interoperability scenarios.

Web service access

Cyscom Software-as-a-Service application web service is available for each individual application at the following url

	http://<site domain name>/_vti_bin/CommonCssa/GeneralCatalogService.asmx

where <site domain name> is the Cyscom Software-as-a-Service application site address, e.g.

	http://mycompany.saas.cyscom.net/_vti_bin/CommonCssa/GeneralCatalogService.asmx

The same credentials as for application site access should be used when accessing GeneralCatalogService.asmx.

Web service methods

GeneralCatalogService.asmx has the following methods

GetItemByEntityCategoryName

public string GetItemByEntityCategoryName(string entityCategoryName, string itemId);

Retrieves specific record from Cyscom SaaS application database.

Parameters:
    entityCategoryName - name of the root category which should define the type of record to retrieve. E.g. Accounts, Tasks, Cases, Users etc.
    itemId - string representation of the record guid (globally unique identifier) which identifies record in Cyscom SaaS database within given record type. E.g. A52D62C7-D9D3-4266-8E0B-487D480AE4F2

Result:
    Record xml. See Item Xml section below.

Example:

string caseRecordXml = catalogServiceProxy.GetItemByEntityCategoryName( "Cases", "A52D62C7-D9D3-4266-8E0B-487D480AE4F2"); 

GetItemByCategoryGroupId

public string GetItemByCategoryGroupId(string categoryGroupId, string itemId); 

Retrieves specific record from Cyscom SaaS application database.

Parameters:
    categoryGroupId - string representation of category group guid(globally unique identifier). Category group defines the type of record to retrieve. E.g. 8fb8615f-c23f-4495-b8ca-299988d018b2.
    itemId - string representation of the record guid (globally unique identifier) which identifies record in Cyscom SaaS database within given category group (entity). E.g. A52D62C7-D9D3-4266-8E0B-487D480AE4F2

Result:
    Record xml. See Item Xml section below.

Example:

string caseRecordXml = catalogServiceProxy.GetItemByCategoryGroupId( "8fb8615f-c23f-4495-b8ca-299988d018b2", "A52D62C7-D9D3-4266-8E0B-487D480AE4F2"); 

GetItemsByEntityCategoryNameAndFilter

public string GetItemsByEntityCategoryNameAndFilter(string entityCategoryName, string filterXml);

Retrieves list of records of certain from Cyscom SaaS application database that meet given criteria.

Parameters:
    entityCategoryName - name of the root category which should define the type of record to retrieve. E.g. Accounts, Tasks, Cases, Users etc.
    filterXml - string representation of the filter xml that defines criteria to select records of given type. See Filter Xml section below.

Result:
    Records list xml. See Records List Xml section below.

Example:

string accountsXml = catalogServiceProxy.GetItemsByEntityCategoryNameAndFilter( "Accounts", "<filter CoreType=\"SinglePropertyValueFilter\" PropertyName=\"Company Name\" Type=\"Equality\"><Value>My Company</Value></filter>"); 

public string GetPropertyById(string propertyId);

Retrieves information on specific property from Cyscom SaaS application database.

Parameters:
    propertyId - string representation of property guid (globally unique identifier) which identifies property in Cyscom SaaS application database. E.g. 4462e80b-6b47-4f7f-950c-f247d23a7780.

Result:
    Property xml. See Property Xml section below.

Example:

string propertyXml = catalogServiceProxy.GetPropertyById( "4462e80b-6b47-4f7f-950c-f247d23a7780"); 

public string GetPropertyByName(string propertyName);

Retrieves information on specific property from Cyscom SaaS application database.

Parameters:
    propertyName - name of the property to retrieve from Cyscom SaaS application database. E.g. Subject (for Cases), Company Name, Priority (for Cases).

Result:
    Property xml. See Property Xml section below.

Example:

string propertyXml = catalogServiceProxy.GetPropertyByName( "Subject (for Cases)"); 

public string GetCategoryById(string categoryId);

Retrieves information on specific category from Cyscom SaaS application database.

Parameters:
    categoryId - string representation of category guid (globally unique identifier) which identifies category in Cyscom SaaS application database. E.g. 0980dcb8-8ac4-4323-8d3b-cc942829b96f.

Result:
    Category xml. See Category Xml section below.

Example:

string categoryXml = catalogServiceProxy.GetCategoryById( "0980dcb8-8ac4-4323-8d3b-cc942829b96f" ); 

public string GetCategoryByName(string categoryName);

Retrieves information on specific category from Cyscom SaaS application database.

Parameters:
    categoryName - name of the category to retrieve from Cyscom SaaS application database. E.g. Accounts, Cases, Products & Services.

Result:
    Category xml. See Category Xml section below.

Example:

string categoryXml = catalogServiceProxy.GetCategoryByName( "Products & Services"); 

public string GetListSetById(string listSetId);

Retrieves information on specific list set from Cyscom SaaS application database.

Parameters:
    listSetId - string representation of list set guid (globally unique identifier) which identifies list set in Cyscom SaaS application database. E.g. 758fbcb3-bcab-4114-ade5-8d87918bd287.

Result:
    List set xml. See List Set Xml section below.

Example:

string listSetXml = catalogServiceProxy.GetListSetById( "758fbcb3-bcab-4114-ade5-8d87918bd287" ); 

public string GetListSetByName(string listSetName) 

Retrieves information on specific list set from Cyscom SaaS application database.

Parameters:
    listSetName - name of the list set to retrieve from Cyscom SaaS application database. E.g. Priority List, Role Approval List.

Result:
    List Set xml. See List Set Xml section below.

Example:

string listSetXml = catalogServiceProxy.GetListSetByName( "Priority List"); 

public string GetUnitSetById(string unitSetId);

Retrieves information on specific unit set from Cyscom SaaS application database.

Parameters:
    unitSetId - string representation of unit set guid (globally unique identifier) which identifies unit set in Cyscom SaaS application database. E.g. 4765e80b-6b47-4f7f-951c-f647a23c7605.

Result:
    Unit set xml. See Unit Set Xml section below.

Example:

string unitSetXml = catalogServiceProxy.GetUnitSetById( "4765e80b-6b47-4f7f-951c-f647a23c7605" ); 

public string GetUnitSetByName(string unitSetName) 

Retrieves information on specific unit set from Cyscom SaaS application database.

Parameters:
    unitSetName - name of the unit set to retrieve from Cyscom SaaS application database. E.g. Weight Unit, currency etc.

Result:
    Unit Set xml. See Unit Set Xml section below.

Example:

string unitSetXml = catalogServiceProxy.GetUnitSetByName( "currency"); 

public string GetSubsetById(string subsetId);

Retrieves information on specific subset from Cyscom SaaS application database.

Parameters:
    subsetId - string representation of subset guid (globally unique identifier) which identifies subset in Cyscom SaaS application database. E.g. 8B42B6B9-026C-4cf2-B774-3077FD3E3DD3.

Result:
    Subset xml. See Subset Xml section below.

Example:

string subsetXml = catalogServiceProxy.GetSubsetById( "8B42B6B9-026C-4cf2-B774-3077FD3E3DD3" ); 

public string GetSubsetByName(string subsetName) 

Retrieves information on specific subset from Cyscom SaaS application database.

Parameters:
    subsetName - name of the subset to retrieve from Cyscom SaaS application database. E.g. Open Events, My Workspaces etc.

Result:
    Subset xml. See Subset Xml section below.

Example:

string subsetXml = catalogServiceProxy.GetSubsetByName( "Open Events"); 

public string GetSubCategories(string parentCategoryName);

Retrieves the list of subcategories for the given category identified by name.

Parameters:
    parentCategoryName - name of the category to retrieve subcategories for. E.g. Accounts, Cases, Products & Services.

Result:
    Category list xml. See Category List Xml section below.

Example:

string categoryListXml = catalogServiceProxy.GetSubCategories( "Products & Services"); 

DeleteItem

public void DeleteItem(string entityCategoryName, string itemId);

Deletes specific record from Cyscom SaaS application database.

Parameters:
    entityCategoryName - name of the root category which should define the type of record to delete. E.g. Accounts, Tasks, Cases, Users etc.
    itemId - string representation of the record guid (globally unique identifier) which identifies record in Cyscom SaaS database within given record type that has to be deleted. E.g. A52D62C7-D9D3-4266-8E0B-487D480AE4F2

Example:

catalogServiceProxy.DeleteItem( "Cases", "A52D62C7-D9D3-4266-8E0B-487D480AE4F2"); 

CommitNewItem

public void CommitNewItem(string itemXml);

Creates new record in Cyscom SaaS application database from given xml definition.

Parameters:
    itemXml - xml definition of the record that has to be created. See Item Xml section below.

Example:

catalogServiceProxy.CommitNewItem( @"
	<Item CoreType=""Item"" Id=""A52D62C7-D9D3-4266-8E0B-487D480AE4F2"" CategoryName=""Cases"">
		<PropertyValues>
			<PropertyValue CoreType=""StringPropertyValue"" PropertyName=""ID (for Cases)"">1</PropertyValue>
			<PropertyValue CoreType=""StringPropertyValue"" PropertyName=""Subject (for Cases)"">Server is unavailable</PropertyValue>
		</PropertyValues>
	</Item>"); 

UpdateItem

public void UpdateItem(string itemXml);

Updates existing record in Cyscom SaaS application database using given xml definition.

Parameters:
    itemXml - xml definition of the record that has to be updated. See Item Xml section below.

Note. The record in database gets fully overwritten with supplied data in xml. E.g. if there is a missing field in xml it will get erased in database. Therefore the correct way to update records is to download existing record xml, modify it and invoke UpdateItem.

Example:

catalogServiceProxy.UpdateItem( @"
	<Item CoreType=""Item"" Id=""A52D62C7-D9D3-4266-8E0B-487D480AE4F2"" CategoryName=""Cases"">
		<PropertyValues>
			<PropertyValue CoreType=""StringPropertyValue"" PropertyName=""ID (for Cases)"">1</PropertyValue>
			<PropertyValue CoreType=""StringPropertyValue"" PropertyName=""Subject (for Cases)"">Server is unavailable</PropertyValue>
		</PropertyValues>
	</Item>"); 

Xml schemas

Item Xml

Item xml contains data for one record from Cyscom Software-as-a-Service application database.

Example

<Item
    CoreType="Item"
    Id="a52d62c7-d9d3-4266-8e0b-487d480ae4f2"
    Category="0980dcb8-8ac4-4323-8d3b-cc932829b95f"
    CategoryName="Cases"
    CategoryPath="Cases"
    SecurityDescriptor="O:BAG:BAD:AI(A;CI;LCSW;;;S-1-5-21-914621048-366205296-3782579767-1226)(A;CIID;LCSW;;;S-1-9-6)(A;CIID;CCDCLCSW;;;BA)(A;CIID;CCDCLCSW;;;S-1-9-0)(A;CIID;CCDC;;;S-1-9-1)(A;CIID;CCLC;;;S-1-9-2)(A;CIID;CCDCLCSW;;;S-1-9-3)(A;CIID;CC;;;S-1-9-11)">
        <PropertyValues>
            <PropertyValue
                CoreType="StringPropertyValue"
                Property="4462e80b-6b47-4f7f-950c-f247d23a7780"
                PropertyName="ID (for Cases)">2510-01</PropertyValue>
            <PropertyValue
                CoreType="StringPropertyValue"
                Property="4462e80b-6b47-4f7f-950c-f247d23a7781"
                PropertyName="Subject (for Cases)">Web Server does not respond</PropertyValue>
        </PropertyValues>
        <IncludeSubsets />
        <ExcludeSubsets />
</Item>

General remarks

Records are the main form representation of user information in Cyscom SaaS application. Item Xml contains data about one record including reference to containing category, property values and explicit relations with subsets.

Elements and Attributes

Item element

Root element of the item xml schema, contains information about one record.

Item element attributes

Item element sub elements

Property Xml

Property xml contains a definition for one record property in Cyscom Software-as-a-Service application database.

Example

<Property 
    CoreType="StringProperty" 
    Id="4462e80b-6b47-4f7f-950c-f247d23a7780" 
    System="False" 
    Fixed="False" 
    Constant="False" 
    Name="ID (for Cases)" 
    Searcheable="True" 
    Sortable="True" 
    NotNull="False" 
    SecurityDescriptor="O:BAG:BAD:AI" 
    PropertyGroup="4462e80b-6b47-4f7f-950c-f647a23c4344">
        <Label CoreType="LocalizedStringDataValue">
            <ValueLanguage="1033">ID</Value>
            <ValueLanguage="1049">ID</Value>
            <ValueLanguage="1031">ID</Value>
            <Synonyms/>
        </Label>
        <Description CoreType="LocalizedTextDataValue" />
        <DefaultValue IsNull="True" />
</Property>

General remarks

Cyscom Software-as-a-Service application database supports several data types for properties. Property data type is determined by CoreType attribute of Property element.

The following property types are supported:

• StringProperty
  Data value type for StringProperty is a simple string of text.
• LocalizedStringProperty
  Data value type for LocalizedStringProperty is a set of simple text strings for every supported language in Cyscom SaaS database.
• BooleanProperty
  Data value for BooleanProperty is one bit of information (true/false).
• IntegerProperty
  Data value for IntegerProperty is an integer number.
• NumberProperty
  Data value for NumberProperty is a floating point number.
• DateTimeProperty
  Data value for DateTimeProperty is a .Net DateTime value.
• GuidProperty
  Data value for GuidProperty is a globally unique identifier (guid).
• FileProperty
  Data value for FileProperty is a binary array of data.
• ImageProperty
  Data value for ImageProperty is a binary array of data that represents an image.
• ListProperty
  Data value for ListProperty is reference to an element of predefined list (List Set).
• MultipleListProperty
  Data value for MultipleListProperty is a set of references to elements of predefined list (ListSet).
• QuantityProperty
  Data value for QuantityProperty is a combined structure of floating point number and a reference to unit of measure taken from predefined list of units (UnitSet).
• PriceProperty
  Data value for PriceProperty is a combined structure of floating point number and two references to units of measure taken from predefined lists of units (UnitSets) which indicate currency and base product unit of measure. Example is $10 per kilogram.
• ItemReferenceProperty
  DataValue for ItemReferenceProperty is a reference to another record from Cyscom SaaS application database taken from fixed category group (entity).
• MultipleItemReferenceProperty
  DataValue for MultipleItemReferenceProperty is a set of references to another records from Cyscom SaaS application database taken from fixed category group (entity).
• SubsetProperty
  DataValue for SubsetProperty is a reference to some subset from Cyscom SaaS application database.
• CategoryProperty
  DataValue for SubsetProperty is a reference to some category from Cyscom SaaS application database.
• UnitSystemProperty
  DataValue for UnitSystemProperty is a reference to some set of units of measure (UnitSet) from Cyscom SaaS application database.
   

Elements and Attributes

Property element

Root element of the property xml schema, contains information about one property.

Property element attributes

Property element sub elements

Category Xml

Category xml contains a definition for one record category in Cyscom Software-as-a-Service application database.

Example

<Category 
	CoreType="Category" 
	Id="0980dcb8-8ac4-4323-8d3b-cc822829b93f" 
	System="False" 
	Fixed="False" 
	Constant="False" 
	Name="Territories" 
	CategoryGroup="1fe6a3a9-916b-47c2-a047-47d752901850" 
	SecurityDescriptor="O:BAG:BAD:AI(A;CI;LC;;;S-1-9-1)(A;CI;LCSW;;;S-1-9-4)(A;CI;LCSW;;;S-1-9-8)(A;CIID;CCDCLCSW;;;BA)(A;CIID;CCDCLCSW;;;S-1-9-0)(A;CIID;CCDC;;;S-1-9-1)(A;CIID;CCLC;;;S-1-9-2)(A;CIID;CCDCLCSW;;;S-1-9-3)(A;CIID;CC;;;S-1-9-11)">
		<Label CoreType="LocalizedStringDataValue">
			<Value Language="1033">Territories</Value>
			<Value Language="1049">Территории</Value>
			<Value Language="1031">Gebiete</Value>
			<Synonyms />
		</Label>
		<Description CoreType="LocalizedTextDataValue" />
		<BriefDescriptionTemplate CoreType="LocalizedTextDataValue" />
		<CaptionDescriptionTemplate CoreType="LocalizedStringDataValue">
			<Value Language="1033">&lt;4462E80B-6B47-4f7f-950C-F247D23A7696&gt;</Value>
			<Value Language="1049">&lt;4462E80B-6B47-4f7f-950C-F247D23A7696&gt;</Value>
			<Value Language="1031">&lt;4462E80B-6B47-4f7f-950C-F247D23A7696&gt;</Value>
		</CaptionDescriptionTemplate>
		<Properties>
			<Property IsPersonal="True" Id="4462e80b-6b47-4f7f-950c-f247d23a7696" />
			<Property IsPersonal="True" Id="4462e80b-6b47-4f7f-950c-f247d23a7697" />
			<Property IsPersonal="True" Id="4462e80b-6b47-4f7f-950c-f247d23a7698" />
			<Property IsPersonal="True" Id="4462e80b-6b47-4f7f-950c-f247d23a7699" />
			<Property IsPersonal="True" Id="4462e80b-6b47-4f7f-950c-f247d23a7702" />
			<Property IsPersonal="True" Id="4422e40b-6b47-4f7f-950c-f647a23c4566" />
			<Property IsPersonal="True" Id="4462e80b-6b47-4f7f-950c-f247d23a7700" />
			<Property IsPersonal="True" Id="4462e80b-6b47-4f7f-950c-f247d23a7803" />
		</Properties>
</Category>

General remarks

Cyscom Software-as-a-Service application database contains a hierarchy of categories which define possible entity types and subtypes of records with entity. Categories are grouped into category groups based on first level categories. Each category group represents an entity. Category defines a set of properties which are available for records within the category. Properties are inherited according to the hierarchy of the categories.

Elements and Attributes

Category element

Root element of the category xml schema, contains information about one category.

Category element attributes

Category element sub elements

Category List Xml

Category xml contains a list of category definitions.

Elements and Attributes

Categories element

Root element of the category list xml schema, contains sub elements for each category.

Categories element sub elements

List Set Xml

List Set xml contains a definition for one list set from Cyscom Software-as-a-Service application database. List Set is an object which contains a named predefined list of values to be used

Example

<ListSet 
	CoreType="LocalizedStringValueListSet"
	Id="758fbcb3-bcab-4114-ade5-8d87918bd287" 
	System="False" 
	Fixed="False"
	Constant="False" 
	Name="Role Approval List">
		<Label CoreType="LocalizedStringDataValue">
			<Synonyms />
		</Label>
		<Description CoreType="LocalizedTextDataValue" />
		<Items>
			<Item CoreType="LocalizedStringDataValue" Id="b358d51f-0f82-424f-92a2-cc54d875b177">
				<Value Language="1033">Pending</Value>
				<Value Language="1049">На рассмотрении</Value>
				<Value Language="1031">Ausstehend</Value>
				<Synonyms />
			</Item>
			<Item CoreType="LocalizedStringDataValue" Id="b358d51f-0f82-424f-92a2-cc54d875b178">
				<Value Language="1033">Approved</Value>
				<Value Language="1049">Согласовано</Value>
				<Value Language="1031">Genehmigt</Value>
				<Synonyms />
			</Item>
			<Item CoreType="LocalizedStringDataValue" Id="b358d51f-0f82-424f-92a2-cc54d875b179">
				<Value Language="1033">Declined</Value>
				<Value Language="1049">Отклонено</Value>
				<Value Language="1031">Abgelehnt</Value>
				<Synonyms />
			</Item>
		</Items>
</ListSet>

General remarks

List Set object contains a predefined list of elements that can be referenced by list property values. It is possible to have List Sets of values of different types. The type of elements of the list is determined by CoreType attribute of ListSet element. The following CoreTypes values are available.

• StringValueListSet
  List of string values   
• LocalizedStringValueListSet
  List of localized string values
• IntegerValueListSet
  List of integer values
• NumberValueListSet
  List of floating point number values
• QuantityValueListSet
  List of quantity values

Elements and Attributes

ListSet element

Root element of the ListSet xml schema, contains information about one List Set.

ListSet element attributes

List Set element sub elements

Unit Set Xml

Unit Set xml contains a definition for one unit set from Cyscom Software-as-a-Service application database. Unit Set is an object which contains a named predefined list of units of measure and conversion rules for them.

Example

<UnitSet 
	Id="7c1eaa7d-70bd-4d48-a450-ac00156334a9" 
	System="False" 
	Fixed="True" 
	Constant="False" 
	Name="currency" 
	CoreType="UnitSet">
		<Label CoreType="LocalizedStringDataValue">
			<Value Language="1033">Currency</Value>
			<Value Language="1049">Валюта</Value>
			<Value Language="1031">Wahrung</Value>
			<Synonyms />
		</Label>
		<Description CoreType="LocalizedTextDataValue">
			<Value Language="1033">currency unitset</Value>
			<Value Language="1049">денежная единица измерения</Value>
		</Description>
		<Units>
			<Unit CoreType="UnitElement" Id="f59b6cf0-f8f1-412e-b5b9-5bfdb270050c" Name="Euro">
				<BriefName CoreType="LocalizedStringDataValue">
					<Value Language="1033">?</Value>
					<Value Language="1049">?</Value>
					<Value Language="1031">Euro</Value>
					<Synonyms />
				</BriefName>
				<FullName CoreType="LocalizedStringDataValue">
					<Value Language="1033">dollar</Value>
					<Value Language="1049">доллар</Value>
				</FullName>
			</Unit>
			<Unit CoreType="UnitElement" Id="407ab1ec-48e7-449b-b82a-381ba10bafef" Name="$">
				<BriefName CoreType="LocalizedStringDataValue">
					<Value Language="1033">$</Value>
					<Value Language="1049">$</Value>
					<Value Language="1031">$</Value>
					<Synonyms />
				</BriefName>
				<FullName CoreType="LocalizedStringDataValue" />
			</Unit>
			<Unit CoreType="UnitElement" Id="26de4044-ed45-4fc5-b0d3-e11dfc8c3f46" Name="RUR">
				<BriefName CoreType="LocalizedStringDataValue">
					<Value Language="1033">RUR</Value>
					<Value Language="1049">RUR</Value>
					<Value Language="1031">RUR</Value>
					<Synonyms />
				</BriefName>
				<FullName CoreType="LocalizedStringDataValue" />
			</Unit>
			<Unit CoreType="UnitElement" Id="31e1c458-f754-4055-8c2a-d9651f04eb9c" Name="GBP">
				<BriefName CoreType="LocalizedStringDataValue">
					<Value Language="1033">GBP</Value>
					<Value Language="1049">GBP</Value>
					<Value Language="1031">GBP</Value>
					<Synonyms />
				</BriefName>
				<FullName CoreType="LocalizedStringDataValue" />
			</Unit>
		</Units>
		<Rules>
			<Rule 
				CoreType="LinearUnitConvertionRule" 
				Id="0fdac39e-d75a-43a8-ae8d-66346120b30c" 
				SourceUnit="f59b6cf0-f8f1-412e-b5b9-5bfdb270050c" 
				TargetUnit="26de4044-ed45-4fc5-b0d3-e11dfc8c3f46" 
				Addend="0" 
				Multiplier="36" />
			<Rule 
				CoreType="LinearUnitConvertionRule" 
				Id="4c9ac216-ccd0-414d-8b28-98da35ee85ac" 
				SourceUnit="f59b6cf0-f8f1-412e-b5b9-5bfdb270050c" 
				TargetUnit="31e1c458-f754-4055-8c2a-d9651f04eb9c" 
				Addend="0" 
				Multiplier="1.32" />
			<Rule 
				CoreType="LinearUnitConvertionRule" 
				Id="e1df14f8-8485-40c1-a708-2129238732a9"
				SourceUnit="f59b6cf0-f8f1-412e-b5b9-5bfdb270050c" 
				TargetUnit="407ab1ec-48e7-449b-b82a-381ba10bafef" 
				Addend="0" 
				Multiplier="1.5" />
		</Rules>
</UnitSet>

General remarks

Unit Set object contains a predefined list of unit of measures and conversion rules for them. Unit set can be used as a base for quantity property or quantity type list set.

Elements and Attributes

UnitSet element

Root element of the UnitSet xml schema, contains information about one Unit Set.

UnitSet element attributes

Unit Set element sub elements

Subset Xml

Subset xml contains a definition for one records subset from Cyscom Software-as-a-Service application database. Subset is an object that represents named filtering criteria for records with one category group (entity).

Example

<Subset 
	Id="acb0eb9b-0cee-4acc-9c71-668417b0fd20" 
	System="False" 
	Fixed="False" 
	Constant="False" 
	Name="Open Events" 
	CategoryGroup="bd13bcf7-8568-4666-aa9b-6f07192b8411">
		<Label CoreType="LocalizedStringDataValue">
			<Value Language="1033">All Open</Value>
			<Value Language="1049">Все открытые</Value>
			<Value Language="1031">Alleoffenen Objekte</Value>
			<Synonyms />
		</Label>
		<Description CoreType="LocalizedTextDataValue" />
		<Filter CoreType="UnionFilter">
			<Filters>
				<Filter 
					CoreType="SinglePropertyValueFilter" 
					Property="fc93c9aa-b43a-44b7-a4bd-7a434ac8ca54" 
					Type="GreaterOrEqual">
					<Value IsNull="True" />
					<Expression>return new Cyscom.XFleX.Core.DataTypes.DataValues.DateTimeDataValue( System.DateTime.UtcNow )</Expression>
				</Filter>
			</Filters>
		</Filter>
</Subset>

General remarks

Subset object contains a filtering criteria which determines records that get into subset. Subset is allowed to contain records only from single category group (entity).

Elements and Attributes

Subset element

Root element of the Subset xml schema, contains information about one Subset.

Subset element attributes

Subset element sub elements

Filter Xml

Filter xml contains a definition for filtering criteria. Filter xml is used as a part of subset definitions or can be passed to GeneralCatalogWebService to build a selection of records that meet certain criteria. There are the following types of filters available:

• CategoryFilter
  Selects items that belong to certain list of categories
• SinglePropertyValueFilter
  Selects item having property value that meet certain condition
• ConstantFilter
  Selects either all items or no items
• IntersectionFilter
  Builds an intersection of several filters, the resulting selection contains items that fall into all source selections
• UnionFilter
  Builds a union of several filters, the resulting selection contains items that fall into at least one of source selections
• KeywordsFilter
  Selects items that have certain keywords in values of their properties
• ItemIdsFilter
  Selects items with ids from given list
• ItemJoinFilter
  Selects items having reference to other items that meet given criteria
• MultipleItemJoinFilter
  Selects items having references to other items that meet given criteria
• NotFilter
  Selects items that don't fall into another filter
• SubsetFilter
  Select items which belong to the given subset
• SubsetIncludeItemsFilter
  Selects items which are explicitly included into subset
• SubsetExcludeItemsFilter
  Selects items which are explicitly excluded from subset

The following sections present xml schemas for every type of filter.

CategoryFilter Xml

Selects items that belong to certain list of categories

Example:

<Filter CoreType="CategoryFilter" IsRecursive="true">
	<Categories>
		<Category Id="0980dcb8-8ac4-4323-8d3b-cc942829b96f"/>
	</Categories>
</Filter>

Elements and Attributes

Filter element

Root element of the Filter xml schema, contains information about one Filter.

Filter element attributes

Filter element sub elements

SinglePropertyValueFilter Xml

Selects items that have property values that meet some criteria

Example:

<Filter CoreType="SinglePropertyValueFilter" 
	Property="4462e80b-6b47-4f7f-950c-f647a23c4556" 
	PropertyName="Company Name" 
	Type="Equality">
		<Value>Volkswagen</Value>
</Filter>

Elements and Attributes

Filter element

Root element of the Filter xml schema, contains information about one Filter.

Filter element attributes

Filter element sub elements

ConstantFilter Xml

Selects items either all items or no items.

Example:

<Filter CoreType="ConstantFilter" Value="true">
</Filter>

Elements and Attributes

Filter element

Root element of the Filter xml schema, contains information about one Filter.

Filter element attributes

IntersectionFilter Xml

Selects items that fall into all of the supplied sub filters. This is the AND logical operation on item selections.

Example:

<Filter CoreType="IntersectionFilter">
	<Filters>
		<Filter CoreType="CategoryFilter" IsRecursive="true">
			<Categories>
				<Category Id="0980dcb8-8ac4-4323-8d3b-cc942829b96f"/>
			</Categories>
		</Filter>
		<Filter CoreType="SinglePropertyValueFilter" PropertyName="Created Date" Type="Greater">
			<Value>01/01/2008</Value>
		</Filter>
	</Filters>
</Filter>

Elements and Attributes

Filter element

Root element of the Filter xml schema, contains information about one Filter.

Filter element sub elements

UnionFilter Xml

Selects items that fall into at least one of the supplied sub filters. This is the OR logical operation on item selections.

Example:

<Filter CoreType="UnionFilter">
	<Filters>
		<Filter CoreType="SinglePropertyValueFilter" PropertyName="Created Date" Type="Greater">
			<Value>01/01/2008</Value>
		</Filter>
		<Filter CoreType="SinglePropertyValueFilter" PropertyName="Created Date" Type="Less">
			<Value>01/01/2006</Value>
		</Filter>
	</Filters>
</Filter>

Elements and Attributes

Filter element

Root element of the Filter xml schema, contains information about one Filter.

Filter element sub elements

KeywordsFilter Xml

Selects items that have property values containing specified keywords

Example:

<Filter CoreType="KeywordsFilter" Keywords="David Edwards">
</Filter>

Elements and Attributes

Filter element

Root element of the Filter xml schema, contains information about one Filter.

Filter element attributes

ItemIdsFilter Xml

Selects items with specified ids

Example:

<Filter CoreType="ItemIdsFilter">
	<Guids>
		<Guid Id="34aa2dae-8935-4adf-b485-44a00049141f"/>
		<Guid Id="93dd56f2-53d4-4e11-872c-cd922d7b51c5"/>
	</Guids>
</Filter>

Elements and Attributes

Filter element

Root element of the Filter xml schema, contains information about one Filter.

Filter element attributes

Filter element sub elements

ItemJoinFilter Xml

Selects items having referenced item that fall into given filter.

Example:

<Filter CoreType="ItemJoinFilter" Property="4462E80B-6B47-4f7f-950C-F647A23C4731">
	<SubFilter CoreType="SinglePropertyValueFilter" 
		PropertyName="Company Name" 
		Type="Equality">
		<Value>Volkswagen</Value>
	</SubFilter>
</Filter>

Elements and Attributes

Filter element

Root element of the Filter xml schema, contains information about one Filter.

Filter element attributes

Filter element sub elements

MultipleItemJoinFilter Xml

Selects items having at least one referenced item that fall into given filter.

Example:

<Filter CoreType="MultipleItemJoinFilter" Property="4462E80B-6B47-4f7f-950C-F647A23C4603">
	<SubFilter CoreType="SinglePropertyValueFilter" 
		PropertyName="First Name (Contact Information)" 
		Type="Equality">
		<Value>Henry</Value>
	</SubFilter>
</Filter>

Elements and Attributes

Filter element

Root element of the Filter xml schema, contains information about one Filter.

Filter element attributes

Filter element sub elements

NotFilter Xml

Selects items that don't fall into given filter within category group (entity).

Example:

<Filter CoreType="NotFilter">
	<SubFilter CoreType="CategoryFilter" IsRecursive="true">
		<Categories>
			<Category Id="960fbb23-ebe9-4744-a379-401b74fb95a9"/>
		</Categories>
	</SubFilter>
</Filter>

Elements and Attributes

Filter element

Root element of the Filter xml schema, contains information about one Filter.

Filter element attributes

Filter element sub elements

SubsetFilter Xml

Selects items that belong to given subset.

Example:

<Filter CoreType="SubsetFilter" Subset="471d4699-eaa1-4144-9ec8-be3be94043c3">
</Filter>

Elements and Attributes

Filter element

Root element of the Filter xml schema, contains information about one Filter.

Filter element attributes

SubsetIncludeItemsFilter Xml

Selects items that are explicitly included into subset.

Example:

<Filter CoreType="SubsetIncludeItemsFilter" Subset="471d4699-eaa1-4144-9ec8-be3be94043c3">
</Filter>

Elements and Attributes

Filter element

Root element of the Filter xml schema, contains information about one Filter.

Filter element attributes

SubsetExcludeItemsFilter Xml

Selects items that are explicitly excluded from subset.

Example:

<Filter CoreType="SubsetExcludeItemsFilter" Subset="471d4699-eaa1-4144-9ec8-be3be94043c3">
</Filter>

Elements and Attributes

Filter element

Root element of the Filter xml schema, contains information about one Filter.

Filter element attributes

Data Value Xml

Data Value xml contains a information for some value of the property or other entity attribute. There are the following types of data values available:

• StringDataValue
  Simple string value
• LocalizedStringDataValue
  A set of strings for each language supported by the system
• LocalizedTextDataValue
  The same as LocalizedStringDataValue but supposed to be used for long strings
• BooleanDataValue
  One bit of data - true or false
• IntegerDataValue
  Integer number
• NumberDataValue
  Floating point numeric value
• DataTimeDataValue
  Date and time
• GuidDataValue
  Globally unique identifier
• FileDataValue
  Binary array of data
• ListElementDataValue
  Reference to an item from predefined list of values (List Set)
• MultipleListElementDataValue
  A set of references to items from predefined list of values (List Set)
• QuantityDataValue
  Combines floating point numeric value and reference to unit of measure from predefined list of units (Unit Set)
• PriceDataValue
  Combines floating point numeric value, reference to currency unit of measure from predefined list of units (Unit Set) and product amount unit of measure from another Unit Set
• ItemReferenceDataValue
  Contains a reference to another record from SaaS application database
• MultipleItemReferenceDataValue
  Contains a set of references to other records from SaaS application database
• SubsetDataValue
  Contains a reference to subset
• CategoryDataValue
  Contains a reference to category
• UnitSystemDataValue
  Contains a reference to Unit Set

Simple Data Value Types

Most of data value types consist of one single value of some simple underlying type. For this kind of data values xml schema contains single element with inner text containing underlying value in string representation. The following example shows StringDataValue Xml

<Value>
    The Web Server does not respond
</Value>

Other simple data value types are:

• StringDataValue (inner text contains string value)
• TextDataValue (inner text contains string value)
• BooleanDataValue (inner text contains strings True or False)
• CategoryDataValue (inner text contains string representation of category guid)
• DateTimeDataValue (inner text contains string representation of date time in invariant culture)
• GuidDataValue (inner text contains string representation of guid)
• IntegerDataValue (inner text contains string representation of integer number)
• ItemReferenceDataValue (inner text contains string representation of referenced item guid)
• ListElementDataValue (inner text contains string representation of referenced list element guid; additionally there is an additional AsString attribute which contains string representation of list element value)
• NumberDataValue (inner text contains string representation of floating point number)
• SubsetDataValue (inner text contains string representation of subset guid)
• UnitSystemDataValue (inner text contains string representation of unit set guid)

For all of data value types there is IsNull attribute in root xml element node. IsNull = true indicates data value has null value.

LocalizedStringDataValue and LocalizedTextDataValue

Example:

<Value>
	<Value Language="1033">All Open</Value>
	<Value Language="1049">Все открытые</Value>
	<Value Language="1031">Alleoffenen Objekte</Value>
	<Synonyms />
</Value>

Elements and Attributes

Root element

Root element of the Data Value xml schema, contains information about one value.

Root element attributes

Root element sub elements

FileDataValue and ImageDataValue

Example:

<Value>
    <Comment CoreType="LocalizedStringDataValue" />
    <Content>...
    </Content>
</Value>

Elements and Attributes

Root element

Root element of the Data Value xml schema, contains information about one value.

Root element attributes

Root element sub elements

MultipleItemReferenceDataValue and MultipleListElementDataValue

Example:

<Value>
    <ValueElement Id="7fa3132f-981b-43c9-a24a-53621ff9966a">f4e9a601-7b0c-4763-b167-5242cbc82bd1</ValueElement>
    <ValueElement Id="6e7055c2-579c-4b60-bcc9-7e734a852708">980e17bb-58c2-458a-acc8-c4c13f567b99</ValueElement>
</Value>

Elements and Attributes

Root element

Root element of the Data Value xml schema, contains information about one value.

Root element attributes

Root element sub elements

QuantityDataValue and PriceDataValue

Example:

<Value Unit="f59b6cf0-f8f1-412e-b5b9-5bfdb270050c" UnitOfMeasure="51eae61f-3e2d-4b24-89df-5081e57b4dd0">
	12
	<PriceOptions />
</Value>

Elements and Attributes

Root element

Root element of the Data Value xml schema, contains information about one value. Inner text contains string representation of quantity floating point value.

Root element attributes

Root element sub elements

Unit Xml

Unit xml contains a definition for a single unit of measure which is the part of Unit Set.

Example

<Unit CoreType="UnitElement" Id="407ab1ec-48e7-449b-b82a-381ba10bafef" Name="$">
	<BriefName CoreType="LocalizedStringDataValue">
		<Value Language="1033">$</Value>
		<Value Language="1049">$</Value>
		<Value Language="1031">$</Value>
		<Synonyms />
	</BriefName>
	<FullName CoreType="LocalizedStringDataValue" />
</Unit>

Elements and Attributes

Unit element

Root element of the Unit xml schema, contains information about one Unit.

Unit element attributes

Unit element sub elements

Rule Xml

Rule xml contains a definition for a conversion rule for a pair of units of measure which is the part of Unit Set.

Example

<Rule 
	CoreType="LinearUnitConvertionRule" 
	Id="0fdac39e-d75a-43a8-ae8d-66346120b30c" 
	SourceUnit="f59b6cf0-f8f1-412e-b5b9-5bfdb270050c" 
	TargetUnit="26de4044-ed45-4fc5-b0d3-e11dfc8c3f46" 
	Addend="0" 
	Multiplier="36" />

Elements and Attributes

Rule element

Root element of the Rule xml schema, contains information about one Rule.

Unit element attributes