Phoenix Developers

Action

Actions are instances of Action Types and are triggered by Events

Properties

Name	Type	Description
Id	System.Int32	the primary Identifier of Action[queryable][sortable]
TriggerId	System.Int32	the Trigger for which this Action belongs to[queryable][required]
ActionTypeId	System.Int32	the type of Action[queryable][required]
Description	System.String	a label for this Action[queryable][sortable]
Configuration	System.String	the XML configuration expressing the required parameters to perform the Action
TargetId	System.Int32	the Id of the object (described in PhoenixIdentity_ResourceId) that is the target of this Action
CreateDate	System.DateTime	UTC date of when this entity was created[readonly]
ModifyDate	System.DateTime	UTC date of when this entity last modifed
LastTriggeredDate	System.DateTime	Unavailable
ActionType	ActionType	Navigation property to ActionType [expandable]

Operations

CreateAction: Creates a new Action objectSoap Rest C#
GetAction: Gets a single Action entity by its IdSoap Rest C#
ListAction: Returns a paged list of Actions optionally filtered and sortedSoap Rest C#
UpdateAction: Updates a list of Action entitiesSoap Rest C#

ActionType

Actions can be attached to an Event via a Trigger. Actions can be just about anything from sending an email in Messaging, to creating an article in Syndicate, to performing a HTTP GET on a custom URL.

Properties

Name	Type	Description
Id	System.Int32	the primary identifier for the ActionType[queryable][sortable][required]
ActionTypeGroupId	System.Int32	the group that this Action belongs to[required]
PhoenixIdentity_ResourceId	System.Int32	The type of Resource within the system that an Action of this ActionType applies to.
PhraseTemplate	System.String	the description of the Action[required]
Reference	System.String	a unique Reference for this Action Type that can be used by external systems[required]
ProjectId	System.Int32	The project that this Analytics item belongs to
Activator	System.String	the full assembly name and version number relating to the component within the processor to service the action[required]
CreateDate	System.DateTime	UTC date of when this Object was created[readonly]
ModifyDate	System.DateTime	UTC date of when this Object last viewed
IsClientSide	System.Boolean	whether this type of Action is performed in the client side SDK, rather than within the platform[queryable][required]
ConfigurationModel	System.String	The model for configuration of an Action of this ActionType
ActionTypeGroup	ActionTypeGroup	Navigation property to ActionTypeGroup [expandable]

Operations

ListActionType: Returns a paged list of ActionTypes optionally filtered and sortedSoap Rest C#

ActionTypeGroup

Each Action belongs to a Group - either a Phoenix module, or an external system

Properties

Name	Type	Description
Id	System.Int32	the primary identifier[queryable][sortable][required]
Description	System.String	the name of this group of ActionTypes[required]
Reference	System.String	a unique Reference for this Category that can be used by external systems[required]
CreateDate	System.DateTime	UTC date of when this Object was created[readonly]
ModifyDate	System.DateTime	UTC date of when this Object last viewed

DeleteResponse

Properties

Name	Type	Description

Operations

DeleteAction: Delete a single Action entity by its IdSoap Rest C#
DeleteTrigger: Delete a single Trigger entity by its IdSoap Rest C#
DeleteWidget: Delete a single Widget entity by its IdSoap Rest C#

EventAggregateDTO

Properties

Name	Type	Description

Operations

ListEventAggregate: Returns a list of events aggregated into a time series interval.Soap Rest C#

EventDTO

Properties

Name	Type	Description

Operations

CreateEvent: Creates an event.Soap Rest C#
ListEvent: Returns a list of events.Soap Rest C#

EventLog

A log of Events that are performed by Users on objects or on other Users - recording the who, what, where, when and how much.

Properties

Name	Type	Description
Id	System.Int32	the primary Identifier[queryable][queryable][sortable][sortable]
ProjectId	System.Int32	the ProjectId that this Event occurred within
CompanyId	System.Int32	the Company that this Event occurred within
ProviderId	System.Int32	the Provider that this Event occurred within
PhoenixIdentity_UserId	System.Int32	The Id of the Phoenix User who performed the action or had the action performed on them (depending on the context of the action)[queryable]
CorrelationId	System.String	Concatenation of the SessionId and ApplicationId passed into the request
EventParentId	System.Int32	Whether this Event is a reply to another EventId
TargetId	System.Int32	the object that the action was performed on. The ActionType determines the class this relates to.[queryable]
Value	System.Double	how much value this action carrier - whether it is 1 view or a rating of 0.8[required]
MetaDataParameters	List<KeyValuePair<string, string>>	optional custom data to log
IpAddress	System.String	IP Address
Progress	System.Byte	How much of the event is completed
StatusDescription	System.String	The moderation status of this event
Success	System.Boolean	If the event is successful.
IsActive	System.Boolean	Whether this EventLog is Active or has been revoked[queryable]
CreateDate	System.DateTime	UTC date of when the Event occurred[queryable][readonly][sortable]
ModifyDate	System.DateTime	UTC date of when the EventLog was last changed[queryable][sortable]
ApplicationId	System.Int32	The Application which recorded the Event[queryable]
ApplicationVersion	System.String	The version of the Application which created the Event.[queryable][sortable]
InstallationId	System.String	The Id of the Installation that generated the Event[queryable]
DeviceType	System.String	The device type of the device which registered the Event[queryable]
OperatingSystemVersion	System.String	The operating system of the device which registered the Event[queryable]
Project	Project	Navigation property to Project [expandable]
EventType	EventType	Navigation property to EventType [expandable]

EventLogAggregateRetrieve

Properties

Name	Type	Description
EventTypeReference	System.String	The types of Event that occurred
Id	System.Int32	the primary Identifier[queryable][queryable][sortable][sortable]
ProjectId	System.Int32	the ProjectId that this Event occurred within
CompanyId	System.Int32	the Company that this Event occurred within
ProviderId	System.Int32	the Provider that this Event occurred within
PhoenixIdentity_UserId	System.Int32	The Id of the Phoenix User who performed the action or had the action performed on them (depending on the context of the action)[queryable]
CorrelationId	System.String	Concatenation of the SessionId and ApplicationId passed into the request
EventParentId	System.Int32	Whether this Event is a reply to another EventId
TargetId	System.Int32	the object that the action was performed on. The ActionType determines the class this relates to.[queryable]
Value	System.Double	how much value this action carrier - whether it is 1 view or a rating of 0.8[required]
MetaDataParameters	List<KeyValuePair<string, string>>	optional custom data to log
IpAddress	System.String	IP Address
Progress	System.Byte	How much of the event is completed
StatusDescription	System.String	The moderation status of this event
Success	System.Boolean	If the event is successful.
IsActive	System.Boolean	Whether this EventLog is Active or has been revoked[queryable]
CreateDate	System.DateTime	UTC date of when the Event occurred[queryable][readonly][sortable]
ModifyDate	System.DateTime	UTC date of when the EventLog was last changed[queryable][sortable]
ApplicationId	System.Int32	The Application which recorded the Event[queryable]
ApplicationVersion	System.String	The version of the Application which created the Event.[queryable][sortable]
InstallationId	System.String	The Id of the Installation that generated the Event[queryable]
DeviceType	System.String	The device type of the device which registered the Event[queryable]
OperatingSystemVersion	System.String	The operating system of the device which registered the Event[queryable]
Project	Project	Navigation property to Project [expandable]
EventType	EventType	Navigation property to EventType [expandable]

EventLogCreate

A log of Events that are performed by Users on objects or on other Users - recording the who, what, where, when and how much.

Properties

Name	Type	Description
EventTypeRef	System.String	The type of action that was performed
Location	System.String	The location that the action occurred. Required format is "latitude, longitude"
Geolocation	Geolocation	The location that the action occurred.
Id	System.Int32	the primary Identifier[queryable][queryable][sortable][sortable]
ProjectId	System.Int32	the ProjectId that this Event occurred within
CompanyId	System.Int32	the Company that this Event occurred within
ProviderId	System.Int32	the Provider that this Event occurred within
PhoenixIdentity_UserId	System.Int32	The Id of the Phoenix User who performed the action or had the action performed on them (depending on the context of the action)[queryable]
CorrelationId	System.String	Concatenation of the SessionId and ApplicationId passed into the request
EventParentId	System.Int32	Whether this Event is a reply to another EventId
TargetId	System.Int32	the object that the action was performed on. The ActionType determines the class this relates to.[queryable]
Value	System.Double	how much value this action carrier - whether it is 1 view or a rating of 0.8[required]
MetaDataParameters	List<KeyValuePair<string, string>>	optional custom data to log
IpAddress	System.String	IP Address
Progress	System.Byte	How much of the event is completed
StatusDescription	System.String	The moderation status of this event
Success	System.Boolean	If the event is successful.
IsActive	System.Boolean	Whether this EventLog is Active or has been revoked[queryable]
CreateDate	System.DateTime	UTC date of when the Event occurred[queryable][readonly][sortable]
ModifyDate	System.DateTime	UTC date of when the EventLog was last changed[queryable][sortable]
ApplicationId	System.Int32	The Application which recorded the Event[queryable]
ApplicationVersion	System.String	The version of the Application which created the Event.[queryable][sortable]
InstallationId	System.String	The Id of the Installation that generated the Event[queryable]
DeviceType	System.String	The device type of the device which registered the Event[queryable]
OperatingSystemVersion	System.String	The operating system of the device which registered the Event[queryable]
Project	Project	Navigation property to Project [expandable]
EventType	EventType	Navigation property to EventType [expandable]

EventLogRetrieve

Properties

Name	Type	Description
EventTypeId	System.Int32	the type of action that was performed
Location	System.String	The location that the action occurred. Required format is "latitude, longitude"
Geolocation	Geolocation	The Geolocation of the Event that occurred.
Id	System.Int32	the primary Identifier[queryable][queryable][sortable][sortable]
ProjectId	System.Int32	the ProjectId that this Event occurred within
CompanyId	System.Int32	the Company that this Event occurred within
ProviderId	System.Int32	the Provider that this Event occurred within
PhoenixIdentity_UserId	System.Int32	The Id of the Phoenix User who performed the action or had the action performed on them (depending on the context of the action)[queryable]
CorrelationId	System.String	Concatenation of the SessionId and ApplicationId passed into the request
EventParentId	System.Int32	Whether this Event is a reply to another EventId
TargetId	System.Int32	the object that the action was performed on. The ActionType determines the class this relates to.[queryable]
Value	System.Double	how much value this action carrier - whether it is 1 view or a rating of 0.8[required]
MetaDataParameters	List<KeyValuePair<string, string>>	optional custom data to log
IpAddress	System.String	IP Address
Progress	System.Byte	How much of the event is completed
StatusDescription	System.String	The moderation status of this event
Success	System.Boolean	If the event is successful.
IsActive	System.Boolean	Whether this EventLog is Active or has been revoked[queryable]
CreateDate	System.DateTime	UTC date of when the Event occurred[queryable][readonly][sortable]
ModifyDate	System.DateTime	UTC date of when the EventLog was last changed[queryable][sortable]
ApplicationId	System.Int32	The Application which recorded the Event[queryable]
ApplicationVersion	System.String	The version of the Application which created the Event.[queryable][sortable]
InstallationId	System.String	The Id of the Installation that generated the Event[queryable]
DeviceType	System.String	The device type of the device which registered the Event[queryable]
OperatingSystemVersion	System.String	The operating system of the device which registered the Event[queryable]
Project	Project	Navigation property to Project [expandable]
EventType	EventType	Navigation property to EventType [expandable]

Operations

CreateEventLog: Record an event interaction against an object within the systemSoap Rest C#
ListEventLog: Returns a paged list of EventLogs optionally filtered and sortedSoap Rest C#
UpdateEventLog: Updates an EventLog entitySoap Rest C#

EventType

A list of interactive Events performed by users and objects such as Media.Uploaded, User.Created, Article.Agreed

Properties

Name	Type	Description
Id	System.Int32	the primary Identier for the Action Type[queryable][sortable]
CompanyId	System.Int32	the Company that this EventType belongs to (if a custom Event)[queryable][sortable]
Name	System.String	the Name of the EntityType[required]
Description	System.String	a verbose Description of this Event Type
Reference	System.String	a label that a third party can use to retrieve this EventType by [queryable][sortable][required]
PhoenixIdentity_ResourceId	System.Int32	Unavailable
CreateDate	System.DateTime	UTC date of when this Object was created[readonly]
ModifyDate	System.DateTime	UTC date of when this Object last viewed
ProjectId	System.Int32	Unavailable

Operations

CreateEventType: Create a new event type attached to an event logSoap Rest C#
ListEventType: Returns a paged list of EventTypes optionally filtered and sortedSoap Rest C#

Project

The Phoenix projects referenced from PhoenixIdenity.Project

Properties

Name	Type	Description
PhoenixIdentity_ProjectId	System.Int32	refers to PhoenixSecurity.Project.Id[queryable][sortable][required]
CreateDate	System.DateTime	UTC date of when this Object was created[readonly]
ModifyDate	System.DateTime	UTC date of when this Object last viewed

Operations

ActivateModule: Activates the Analytics module for specified project.Soap Rest C#
GetModuleSettings: Retrieves the Analytics modules settings for the specified project.Soap Rest C#

Task`1

Properties

Name	Type	Description

Operations

ListEventLogAggregate: Returns a paged list of aggregated EventLogs optionally filtered and sortedSoap Rest C#

Trigger

A Trigger is a pattern match on a particular Event. For example a Trigger can be configured to fire when an SMS is recevied on a particular account with a particular message in the body.

Properties

Name	Type	Description
Id	System.Int32	the primary identifier[queryable][sortable]
Description	System.String	A verbose description of this trigger
EventTypeId	System.Int32	the type of Event that this Trigger relates to[queryable][required]
Configuration	System.String	the configuration XML expressing the parameters needed to understand the Event
CreateDate	System.DateTime	UTC date of when this Object was created[readonly]
ModifyDate	System.DateTime	UTC date of when this Object was modified
StartDate	System.DateTime	the date that this Trigger begins to be effective[queryable]
EndDate	System.DateTime	the date that this Trigger ceases to be effective[queryable]
TriggerTypeId	System.Int32	the type of Trigger that this is[queryable][sortable]
ProjectId	System.Int32	the ProjectId that this Trigger belongs to. A null values represents a Global Trigger[queryable]
IsActive	System.Boolean	whether this Trigger is currently active or not[queryable][required]
HasDependencyError	System.Boolean	whether this Trigger has dependency errors[queryable][required]
TargetId	System.Int32	an optional Id that this Trigger targets (of type EventTypeId.ResourceTypeId)[queryable]
TargetName	System.String	an optional name of the Target for display purposes
GroupId	System.Int32	an optional GrouId that this Trigger is concerned with[queryable]
GroupName	System.String	an optional name of the Group for display purposes
Name	System.String	A short name for this Trigger[queryable]
TriggerType	TriggerType	Navigation property to TriggerType [expandable]
EventType	EventType	Navigation property to EventType [expandable]
Actions	ICollection[]	Navigation property to Action [expandable]
Project	Project	Navigation property to Project [expandable]

Operations

CreateTrigger: Creates a new Trigger objectSoap Rest C#
GetTrigger: Gets a single Trigger entity by its IdSoap Rest C#
ListTrigger: Returns a paged list of Triggers optionally filtered and sortedSoap Rest C#
UpdateTrigger: Updates a list of Trigger entitiesSoap Rest C#

TriggerType

TriggerTypes outline the required conditional template that Triggers must implement

Properties

Name	Type	Description
Id	System.Int32	the primary identifier[queryable][sortable]
Name	System.String	the name of this TriggerType[queryable][sortable][required]
PhraseTemplate	System.String	the template to build a natural language phrase describing this type of Trigger
CreateDate	System.DateTime	UTC date of when this Object was created[readonly]
ModifyDate	System.DateTime	UTC date of when this Object was modified
TriggerResolver	System.String	The Class to instantiate for resolution of the Trigger
ConfigurationModel	System.String	The model for configuration of a Trigger of this TriggerType

Operations

ListTriggerType: Returns a paged list of TriggerTypes optionally filtered and sortedSoap Rest C#

Widget

Widgets are a variety of charts that visualise the analytics within the platform

Properties

Name

Type

Description

System.Int32

the primary identifier[queryable][sortable]

ProjectId

System.Int32

The project to which the Widget is associated with[required]

WidgetTypeId

WidgetTypeEnum

The type of widget this is

Name

System.String

The name of the Widget[required]

Parameter

System.String

An optional parameter used to generate the Widget

SortOrder

System.Int32

the order in which the Widgets should be displayed[queryable][sortable][required]

CreateDate

System.DateTime

UTC date of when this Object was created[readonly]

ModifyDate

System.DateTime

UTC date of when this Object was modified

Width

System.Int32

The width of the Widget in units of 1 (default 1).

Project

Project

Navigation property to Project [expandable]

Operations

CreateWidget: Creates a new Widget objectSoap Rest C#
GetWidget: Gets a single Widget entity by its IdSoap Rest C#
ListWidget: Returns a paged list of Widgets optionally filtered and sortedSoap Rest C#
UpdateWidget: Updates a list of Widget entitiesSoap Rest C#