CommonEntityService
Web services for managing common entities and hierarchical categories.
Endpoint Metadata
- Namespace: http://opencase.extend.com/webservices/commonentity
- Endpoint Name: CommonEntityWebService
- Endpoint Address: http(s)://{VMS URL}/ContentManager/webservices/commonentity-service
The following methods are available on this endpoint:
Create new categories using the passed data.
Input Parameters
Return Value
Faults
name |
description |
CommonEntityParameterFault |
If any error occurs when trying to validate categories. |
CommonEntityWebserviceFault |
For any business-related errors. |
Creates common entities from passed xml.
Input Parameters
name |
type |
description |
xml |
string |
string containing the data for common entities to be created |
Return Value
Faults
name |
description |
CommonEntityParameterFault |
if xml is null or empty or if common entity can not be created |
Creates a new common entity for all locales existing in the system. If applyToAllLocales flag is not specified or it's set tofalse - then applyToAllLocales is set true.
The following basic validation is performed on the incoming common entity data:
common entity Primary Key - Must not be specified. Common entity name - Mustbe specified. common entity UUID - Must not be specified. common entity Creation Date - Must not be specified. common entity Last Modified Date - Mustnot be specified. common entity Locales - Must not be specified.
In 5.1 the preferred way to create Category this is via #createCategories(List) otherwise the legacy category will be createdinstead of hierarchical.
Input Parameters
name |
type |
description |
commonEntityToCreate |
CommonEntity
|
The data for the common entity to be created. |
Return Value
Faults
name |
description |
CommonEntityParameterFault |
If any of the passed common entity parameters do not pass validation. The passed common entity isconsidered invalid in all of the following cases- the commonEntityToCreate is null
- the UUID of the commonEntityToCreate has a value
- the createDate of the commonEntityToCreate has a value
- the lastModifiedDate of the commonEntityToCreate has a value
|
CommonEntityWebserviceFault |
For any business-related errors. |
This method has been deprecated.
Creates a new common entity and adds all the supplied locales to this common entity. Locales may be provided as part of Common Entity,as list of localePKs or by setting applyToAllLocales as true.
The following basic validation is performed on the incoming common entity data:
Common Entity Primary Key - Must not be specified.Common entity name - Must be specified.Common entity UUID - Must not be specified.Common entity Creation Date - Must not be specified.Common entity Last Modified Date - Must not be specified.At least one locale must be provided.Common entity Locales list - Must be empty if applyToAllLocales=trueLocale Primary Key list - overrides Common entity Locales list, Must be empty if applyToAllLocales=true
In 5.1 the preferred way to create Category this is via #createCategories(List) otherwise the legacy category will be createdinstead of hierarchical.
Input Parameters
name |
type |
description |
commonEntityToCreate |
CommonEntity
|
The data for the common entity to be created. |
localePks |
integer[] |
A list of locale primary keys. These are used to retrieve a locale set that will be applied to the new common entity. |
Return Value
type |
description |
CommonEntity
|
The new common entity with locale information. |
Faults
name |
description |
CommonEntityParameterFault |
If the passed common entity data does not pass validation. The passed parameters are considered invalidin all of the following cases- the commonEntityToCreate is null
- the UUID of the commonEntityToCreate has a value
- the createDate of the commonEntityToCreate has a value
- the lastModifiedDate of the commonEntityToCreate has a value
- the locale does not exist for any of the given localePks
|
CommonEntityWebserviceFault |
For any business-related errors. |
Create new genres using the passed data.
Input Parameters
name |
type |
description |
genresToCreate |
list<Genre>
|
The list of passed genres that should be created. |
Return Value
type |
description |
list<Genre>
|
The list of created genres. |
Faults
name |
description |
CommonEntityParameterFault |
If any error occurs when trying to validate genres. |
CommonEntityWebserviceFault |
For any business-related errors. |
Deletes an existing Category.
Input Parameters
Faults
name |
description |
CommonEntityParameterFault |
If any error occurs when trying to find category. |
CommonEntityWebserviceFault |
For any business-related errors. |
Deletes an existing common entity.
Common Entity PK - Must be specified.
Note
- When a talent role is deleted if the related person has no more talent roles associated with themselves, the person willalso be deleted.
In 5.1 the preferred way to delete Category this is via #deleteCategory(HierarchicalCategory) otherwise the legacy category can bedeleted.
Input Parameters
name |
type |
description |
commonEntityToDelete |
CommonEntity
|
The common entity to be deleted. |
Faults
name |
description |
CommonEntityParameterFault |
If the passed parameter is null or the primary key of the passed common entity is null |
CommonEntityWebserviceFault |
If the common entity deletion fails for any reason. |
Deletes an existing genre.
Input Parameters
name |
type |
description |
genreToDelete |
Genre
|
The genre that should be deleted. |
Faults
name |
description |
CommonEntityParameterFault |
If any error occurs when trying to find genre. |
CommonEntityWebserviceFault |
For any business-related errors. |
This method has been deprecated. return all categories
Retrieve a list of all categories bound to selected locale.
Input Parameters
name |
type |
description |
locale |
Locale
|
The locale that will be used for search categories. |
Return Value
Faults
name |
description |
CommonEntityParameterFault |
If any error occurs when trying to find locale. |
CommonEntityWebserviceFault |
For any business-related errors. |
Finds a common entity by a specific discriminator. Since the discriminator field is not unique, this method returns list of commonentities.
Input Parameters
name |
type |
description |
discriminator |
string |
discriminator of a given type, which instances must be found. |
Return Value
type |
description |
list<CommonEntity>
|
All common entities having the specified discriminator. |
Faults
name |
description |
CommonEntityParameterFault |
If the specified parameter is invalid. The parameter discriminator is considered invalid if it is nullor empty. |
CommonEntityWebserviceFault |
if operation can not be successfully performed for some reasons. |
This method has been deprecated. return all genres
Retrieve a list of all genres bound to selected locale.
Input Parameters
name |
type |
description |
locale |
Locale
|
The locale that will be used for search genres. |
Return Value
type |
description |
list<Genre>
|
The list of all genres under passed locale. |
Faults
name |
description |
CommonEntityParameterFault |
If any error occurs when trying to find locale. |
CommonEntityWebserviceFault |
For any business-related errors. |
Finds all the parent genres
Return Value
type |
description |
list<Genre>
|
listofParentGenres list of all the parent genres(root genres) |
Faults
name |
description |
CommonEntityWebserviceFault |
if any errors |
Retrieve a list of all talent roles.
Return Value
Faults
name |
description |
CommonEntityWebserviceFault |
in case of unexpected error. |
Retrieve a list of all categories that match the given category object that hasn't NULL fields.
Input Parameters
name |
type |
description |
categoryToSearch |
HierarchicalCategory
|
The category that should be used for match. |
Return Value
Faults
name |
description |
CommonEntityParameterFault |
If any error occurs when trying to find categories. |
CommonEntityWebserviceFault |
For any business-related errors. |
Retrieve a list of child categories of the given category.
Input Parameters
name |
type |
description |
categoryToSearch |
HierarchicalCategory
|
The category that should be used for search. |
Return Value
Faults
name |
description |
CommonEntityParameterFault |
If any error occurs when trying to find category. |
CommonEntityWebserviceFault |
For any business-related errors. |
Retrieve a list of all common entities that match the given CommonEntity object that hasn't NULL fields.
Use the SearchableField annotation to set the fields allowed to search.
Input Parameters
name |
type |
description |
abstractCommonEntity |
CommonEntity
|
abstract common entity for which search is performed |
Return Value
type |
description |
list<CommonEntity>
|
List of all common entities that match the given CommonEntity object that has the not NULL fields. |
Faults
name |
description |
CommonEntityParameterFault |
will be thrown in case if abstract common entity parameter is null |
CommonEntityWebserviceFault |
will be thrown in case of unexpected error. |
Finds a common entity with a specific External ID and a specific discriminator. Since the External ID field is unique per type of commonentity, this method returns one common entity.
Input Parameters
name |
type |
description |
externalID |
string |
The External ID field of the common entity to retrieve. |
discriminator |
string |
String indicating which type of Common Entity to search for. |
Return Value
type |
description |
CommonEntity
|
A common entity matching the specified External ID and discriminator. If no common entity is found, a null value isreturned. |
Faults
name |
description |
CommonEntityParameterFault |
If any specified parameters are invalid. The parameters External ID and Discriminator are consideredinvalid if either are null or empty. |
CommonEntityWebserviceFault |
If application exception occurs. |
Finds a common entity with a specific primary key. Since the primary key field is unique, this method returns one common entity.
Input Parameters
name |
type |
description |
commonEntityPrimaryKey |
integer |
The primary key of the common entity to retrieve. |
Return Value
type |
description |
CommonEntity
|
A common entity matching the specified primary key. If no common entity is found, a null value is returned. |
Faults
name |
description |
CommonEntityParameterFault |
If the specified parameter is invalid.The parameter is considered invalid in all of the following cases- the commonEntityPrimaryKey is null or zero
- no common entity exists with the given commonEntityPrimaryKey
|
Finds a common entity with a specific UUID. Since the UUID field is unique, this method returns one common entity.
Input Parameters
name |
type |
description |
uuid |
string |
The UUID field of the common entity to retrieve. |
Return Value
type |
description |
CommonEntity
|
A common entity matching the specified UUID. If no common entity is found, a null value is returned. |
Faults
name |
description |
CommonEntityParameterFault |
If the specified parameter is invalid. The parameter UUID is considered invalid if it is null or empty |
CommonEntityWebserviceFault |
if application exception occurs. |
Finds the parent genres by the sub genre
Input Parameters
name |
type |
description |
subGenre |
Genre
|
the subGenre |
Return Value
type |
description |
Genre
|
parentGenre the parent genre of the matching sub genre |
Faults
name |
description |
CommonEntityWebserviceFault |
if any errors |
Retrieve a list of all genres that match the given genre object that hasn't NULL fields.
Input Parameters
name |
type |
description |
genreToSearch |
Genre
|
The genre that should be used for match. |
Return Value
type |
description |
list<Genre>
|
The list of found genres that matches passed genre. |
Faults
name |
description |
CommonEntityParameterFault |
If any error occurs when trying to find genres. |
CommonEntityWebserviceFault |
For any business-related errors. |
Retrieve a list of all persons that match the given Person object that has not NULL fields.
Use the SearchableField annotation to set the fields allowed to search.
Input Parameters
name |
type |
description |
person |
Person
|
person object for which search will be performed. Must not contain not-null fields. |
Return Value
type |
description |
list<Person>
|
List of all persons that match the given Person object that has the not NULL fields. |
Faults
name |
description |
CommonEntityParameterFault |
throws if person parameter is null. |
CommonEntityWebserviceFault |
A business exception thrown for any non-parameter errors |
Retrieve a list of sub genres of the given genre.
Input Parameters
name |
type |
description |
parentGenreToSearch |
Genre
|
(no documentation provided) |
Return Value
type |
description |
list<Genre>
|
The list of child genres for parent genre. |
Faults
name |
description |
CommonEntityParameterFault |
If any error occurs when trying to find category. |
CommonEntityWebserviceFault |
For any business-related errors. |
Finds a specified component contained inside of a specified bundle and returns the Provider associated with the direct parentbundle of the found component. I.e. if the component is in a DVD bundle under a LogicalVideo, then the Provider of the LogicalVideo willbe returned.
Input Parameters
name |
type |
description |
componentUuid |
string |
The UUID of the component to find. |
bundleUuid |
string |
The UUID of the bundle that contains that must contains the specified component. |
Return Value
type |
description |
Provider
|
The Provider Entity of the component's parent bundle. A value of null will be returned if there is noprovider associated with the bundle. |
Faults
name |
description |
CommonEntityParameterFault |
If any of the search parameters specified are null or empty. |
CommonEntityWebserviceFault |
If any error occurs when trying to find the Provider. |
Returns the Provider Entity associated with the bundle specified by the bundle UUID.
Input Parameters
name |
type |
description |
bundleUuid |
string |
the UUID of the bundle to get the provider from. |
Return Value
type |
description |
Provider
|
The Provider Entity associated with the bundle matching the specified bundle UUID. A value of null will bereturned if there is no provider associated with the bundle. |
Faults
name |
description |
CommonEntityParameterFault |
If the bundle UUID provided is null or empty. |
CommonEntityWebserviceFault |
If no bundle with provided UUID if found. |
Update given category with the provided data.
Input Parameters
Return Value
Faults
name |
description |
CommonEntityParameterFault |
If any error occurs when trying to validate category. |
CommonEntityWebserviceFault |
For any business-related errors. |
Updates an existing common entity with the provided data.
The following example applies to updating a Talent common entity:
Person - Primary key. Must be specified. Talent Role - Primary key or rolename (or both). This must be specified. New talent roles cannot be added. If only one value is specified, it will be used as the lookupcriteria. If both values are specified, they must match each other in the database
In 5.1 the preferred way to update Category this is via #updateCategory(HierarchicalCategory) otherwise the legacy category can beupdated.
Input Parameters
name |
type |
description |
commonEntityToUpdate |
CommonEntity
|
The common entity to update. |
Return Value
Faults
name |
description |
CommonEntityParameterFault |
If the common entity to update is null or the primary key of the commonEntityToUpdate is null or zeroor the UUID of the passed common entity doesn't match with the common entity in the database |
CommonEntityWebserviceFault |
If the commonEntityToUpdate doesn't match any existing common entity or any business-related errors. |
Updates configuration for com.extend.opencase.occ.client.util.ConfigConstants.COMMON_ENTITY_LOCK_CREATE flag with provided value.
Input Parameters
name |
type |
description |
value |
boolean |
The new value for com.extend.opencase.occ.client.util.ConfigConstants.COMMON_ENTITY_LOCK_CREATE. |
Faults
name |
description |
CommonEntityWebserviceFault |
If the configuration property cannot be updated for any reason. |
Updates CommonEntity locked flag with provided value.
Input Parameters
name |
type |
description |
commonEntityPk |
integer |
The primary key of the CommonEntity to be updated. |
value |
boolean |
The new value for licked flag. |
Faults
name |
description |
CommonEntityParameterFault |
If commonEntityPk == null or Common entity with provided commonEntityPk does not exist. |
CommonEntityWebserviceFault |
If the CommonEntity cannot be updated for any reason. |
Updates configuration for com.extend.opencase.occ.client.util.ConfigConstants.COMMON_ENTITY_LOCK_UPDATE flag with provided value.
Input Parameters
name |
type |
description |
value |
boolean |
The new value for com.extend.opencase.occ.client.util.ConfigConstants.COMMON_ENTITY_LOCK_UPDATE. |
Faults
name |
description |
CommonEntityWebserviceFault |
If the configuration property cannot be updated for any reason. |
This method has been deprecated.
Updates an existing common entity and sets all the supplied locales to this common entity.Locales may be provided as part of Common Entity or as list of localePKs, or by setting applyToAllLocales field as true.
The following rules apply to updating Talent:
Person - Primary key must be specified Talent Role - Primary key, or rolename, or both, must be specified. If only one is specified, it will be used as the criteria for lookup (no new talent roles can be added).If both are specified, they must be a matched pair - the pk must match the name as specified in the database
In 5.1 the preferred way to update Category this is via #updateCategory(HierarchicalCategory) otherwise the legacy category can beupdated.
Input Parameters
name |
type |
description |
commonEntityToUpdate |
CommonEntity
|
The common entity that is to be updated. |
localePks |
integer[] |
The list of locale primary keys. Based on that, a set of retrieved locales will be apply to this specific common entity. |
Return Value
type |
description |
CommonEntity
|
The common entity that has been updated. |
Faults
name |
description |
CommonEntityParameterFault |
If the common entity to update does not pass validation. The passed parameters are considered invalidin all of the following cases- commonEntityToUpdate is null
- the primaryKey of the commonEntityToUpdate is null or zero
- a locale doesn't exist for one of the passed localePks
- Common entity Locales list - Must be empty if applyToAllLocales true
- Locale Primary Key list - overrides Common entity Locales list, Must be empty if applyToAllLocales true
|
CommonEntityWebserviceFault |
For any business-related errors. |
Update given genre the provided data.
Input Parameters
name |
type |
description |
genreToUpdate |
Genre
|
The genre that should be updated. |
Return Value
type |
description |
Genre
|
The updated genre. |
Faults
name |
description |
CommonEntityParameterFault |
If any error occurs when trying to validate category. |
CommonEntityWebserviceFault |
For any business-related errors. |