EventService
Endpoint Metadata
- Namespace: http://opencase.extend.com/contentprocessor/webservices/event
- Endpoint Name: EventWebService
- Endpoint Address: http(s)://{VMS URL}/ContentProcessor/webservices/event-service
The following methods are available on this endpoint:
Activates specified EventMappings objects.
Input Parameters
name |
type |
description |
eventMappingPks |
list |
The List containing primary key values of event mapping |
Faults
name |
description |
EventWebServiceFault |
If any error has prevented the event mapping from being activated |
Activates EventMappings objects by specified creator id.
Input Parameters
name |
type |
description |
creatorId |
string |
The creator id value |
Faults
name |
description |
EventWebServiceFault |
If any error has prevented the event mapping from being activated |
Activates EventMappings objects by specified name of the event type and creator id.
Input Parameters
name |
type |
description |
eventTypeName |
string |
The name of the event type |
creatorId |
string |
The creator id value |
Faults
name |
description |
EventWebServiceFault |
If any error has prevented the event mapping from being activated |
Creates a new EventMapping entity using the provided entity object.
Input Parameters
name |
type |
description |
eventMapping |
EventMapping
|
The EventMapping entity to create. Must not be null |
Return Value
type |
description |
EventMapping
|
EventMapping A newly created EventMapping entity |
Faults
name |
description |
EventWebServiceFault |
If any error has prevented the event mapping from being created |
Deactivates specified EventMappings objects.
Input Parameters
name |
type |
description |
eventMappingPks |
list |
The List containing primary key values of event mapping |
Faults
name |
description |
EventWebServiceFault |
If any error has prevented the event mapping from being deactivated |
Deactivates EventMappings objects by specified creator id.
Input Parameters
name |
type |
description |
creatorId |
string |
The creator id value |
Faults
name |
description |
EventWebServiceFault |
If any error has prevented the event mapping from being deactivated |
Deactivates EventMappings objects by specified name of the event type and creator id.
Input Parameters
name |
type |
description |
eventTypeName |
string |
The name of the event type |
creatorId |
string |
The creator id value |
Faults
name |
description |
EventWebServiceFault |
If any error has prevented the event mapping from being deactivated |
Input Parameters
name |
type |
description |
eventTypeName |
string |
Event type name |
eventData |
string |
Event data |
interval |
int |
Event retry interval |
Faults
name |
description |
EventWebServiceFault |
If any error has prevented the event mapping from being deactivated. |
Retrieves all EventTypes configured in system.
Return Value
Faults
name |
description |
EventWebServiceFault |
If any error has prevented the event types from being retrieved |
Retrieves EventMappings by specified creator id value.
Input Parameters
name |
type |
description |
creatorId |
string |
creator id value |
Return Value
Faults
name |
description |
EventWebServiceFault |
If any error has prevented the event mappings from being retrieved |
Retrieves EventMappings by specified EventType primary key value.
Input Parameters
name |
type |
description |
eventTypePk |
integer |
EventType primary key value. Must not be null |
includeOnlyActive |
boolean |
If true only active instances will be included. Must not be null |
Return Value
Faults
name |
description |
EventWebServiceFault |
If any error has prevented the event mappings from being retrieved |
Retrieves EventMappings by specified EventType primary key and creator id value.
Input Parameters
name |
type |
description |
eventTypePk |
integer |
EventType primary key value |
creatorId |
string |
creator id value |
includeOnlyActive |
boolean |
include only active instances |
Return Value
Faults
name |
description |
EventWebServiceFault |
If any error has prevented the event mappings from being retrieved |
Retrieves EventMappings by specified EventType primary key and source key values.
Input Parameters
name |
type |
description |
eventTypePk |
integer |
EventType primary key value. Must not be null |
sourceKey |
string |
source key value. Must not be null |
includeOnlyActive |
boolean |
include only active instances. Must not be null |
Return Value
Faults
name |
description |
EventWebServiceFault |
If any error has prevented the event mappings from being retrieved |
Retrieves EventMappings by specified EventType primary key and source key list values.
Input Parameters
name |
type |
description |
eventTypePk |
integer |
EventType primary key value. Must not be null |
sourceKeyList |
list |
source key list value. Must not be null |
includeOnlyActive |
boolean |
include only active instances.Must not be null |
Return Value
Faults
name |
description |
EventWebServiceFault |
If any error has prevented the event mappings from being retrieved |
Retrieves EventCommand entity by name value.
Input Parameters
name |
type |
description |
eventCommandName |
string |
(no documentation provided) |
Return Value
type |
description |
EventCommand
|
EventCommand value or null if event command wasn't found |
Faults
name |
description |
EventWebServiceFault |
If any error has prevented the event command from being retrieved |
Retrieves EventCommand entity by primary key value.
Input Parameters
name |
type |
description |
eventCommandPk |
integer |
he primary key of the event command to find. Must not be null |
Return Value
type |
description |
EventCommand
|
EventCommand value or null if event command wasn't found |
Faults
name |
description |
EventWebServiceFault |
If any error has prevented the event command from being retrieved |
Retrieves EventType entity by name value.
Input Parameters
name |
type |
description |
eventTypeName |
string |
The name of the event type to find. Must not be null |
Return Value
type |
description |
EventType
|
EventType value or null if event type wasn't found |
Faults
name |
description |
EventWebServiceFault |
If any error has prevented the event type from being retrieved |
Retrieves EventType entity by primary key value.
Input Parameters
name |
type |
description |
eventTypePk |
integer |
(no documentation provided) |
Return Value
type |
description |
EventType
|
EventType value or null if event type wasn't found |
Faults
name |
description |
EventWebServiceFault |
If any error has prevented the event type from being retrieved |
Retrieves EventType entity by UUID value.
Input Parameters
name |
type |
description |
eventTypeUuid |
string |
The UUID of the event type to find. Must not be null |
Return Value
type |
description |
EventType
|
EventType value or null if event type wasn't found |
Faults
name |
description |
EventWebServiceFault |
If any error has prevented the event type from being retrieved |
Removes a new EventMapping entity using the provided primary key value.
Input Parameters
name |
type |
description |
eventMappingPk |
integer |
specified primary key value. Must not be null |
Faults
name |
description |
EventWebServiceFault |
If any error has prevented the event mapping from being removed |
Active/inactive event type.
Input Parameters
name |
type |
description |
name |
string |
Event type name |
isActive |
boolean |
Active or inactive |
Faults
name |
description |
EventWebServiceFault |
If any error has prevented the event mapping from being deactivated |
Updates an existing EventMapping entity using the provided entity object.
Input Parameters
name |
type |
description |
eventMapping |
EventMapping
|
The EventMapping entity to update. Must not be null |
Faults
name |
description |
EventWebServiceFault |
If any error has prevented the event mapping from being updated |