Skip to main content

 

 

 

 

Template:OutSystems/Documentation_KB/Breadcrumb_New_Layout

 

 

Template:OutSystems/OSLanguageSwitcher

 

 

 

OutSystems

Case Configurations API

The Case Configurations API includes actions used to configure a case in your app. Use this API to access all the CRUD operations for different case features, for example, rules, or to set up templates.

For example, this API is used to configure the following entities related to the cases of your application:

  • Case Definition.
  • Case Statuses.
  • StateMachine.
  • Rules.

Summary

Action Description
BootstrapCaseConfiguration Bootstraps the case configuration
Calendar_Create Action to create a new calendar
Calendar_CreateOrUpdate Action to create or update a calendar
Calendar_Delete Deletes an existiing calendar
Calendar_Update Update an existing calendar
CaseAction_Bootstrap Bootstraps the list of Case Workflow Actions
CaseDefinition_CheckValidStatus Checks if the status is valid for a specific case definition
CaseDefinition_Create Creates a new case definition
CaseDefinition_CreateOrUpdate Creates or updates a case definition
CaseDefinition_Delete Deletes an existing case definition
CaseDefinition_GetActions Gets the actions associated to a case definition
CaseDefinition_GetAll Gets the list of active CaseDefinitions
CaseDefinition_GetById Gets a specific Case Definition by case identifier
CaseDefinition_GetDetailByProcessDefinitionId Gets the Case Definition details
CaseDefinition_GetEligibleToPurge Get the case definitions that are eligible to purge, ie, without any case instance and which application is also deleted
CaseDefinition_GetEntityId Gets the associated entity identifier
CaseDefinition_GetInitialStatus Gets the initial status for a given case definition.
CaseDefinition_GetProcessDefinitionId Gets the associated process definition identifier
CaseDefinition_GetProcessDefinitionList Gets the list of process definitions associated with case definitions
CaseDefinition_GetStatusList Gets the list of all valid statuses for a given case definition.
CaseDefinition_PreviewByProcessDefinition Previews the keys for the CaseDefinition based on a ProcessDefinition
CaseDefinition_Purge Purges a Case Definition
CaseDefinition_Update Updates an existing case definition
CaseStateMachine_Create Creates a new State Machine entry
CaseStateMachine_CreateOrUpdate Creates or updates a State Machine entry
CaseStateMachine_Purge Purge a Case State Machine
CaseStateMachine_Update Updates an existing State Machine entry
CaseStatus_Bootstrap Will replace the existing case definiton statuses (or create if new) for a specific CaseDefinition
CaseStatus_Create Creates a new Case Status
CaseStatus_CreateOrUpdate Creates or updates a Case Status
CaseStatus_Delete Deletes a Case Status
CaseStatus_GetById Gets the status details by identifier
CaseStatus_Update Updates an existing Case Status
CaseTag_Create Enables to create a CaseTag instance in the CaseTag entity
CheckApplicationStatus Check the status of an application
Delegation_Create Creates a new Delegation
Delegation_CreateOrUpdate Creates or updates a delegation
Delegation_Delete Deletes an existing Delegation. Can only be removed by the user that created the delegation, if not it will raise an exception.
Delegation_Update Updates an existing Delegation. Can only be updated by the user that created the delegation, if not it will raise an exc
Email_ProcessPlaceholders It will replace the placeholders by the actual case data
EmailTemplate_Create Creates an EmailTemplate object
EmailTemplate_CreateOrUpdate Creates or updates an EmailTemplate object
EmailTemplate_GetAll Gets all EmailTemplates that matches the search criteria
EmailTemplate_GetById Gets a EmailTemplate by Id
EmailTemplate_Update Updates an EmailTemplate object
EntityAttr_GetByGlobalKey Gets the AttributeId based on it's GlobalKey
Espace_GetForActivityScreen Gets list of espaces that can have screens to an activity can be opened by
GetBusinessEntities Gets the list of business entities based on a case definition
GetBusinessEntityAttributes Gets the list of business entities attributes based on an entity
GetSystemDefaultDaysToPurge Gets the system sefault days to purge the case data
GlobalKey_Parse Parses a GlobalKey
Group_AssignGroupToUser Assigns a user to a group
Group_GetGroupsToAssociate Gets existing groups not associated with group extended that can be associated
Group_UnassignGroupFromUser Removes the user association fromo a group
GroupExtended_CreateOrUpdate Creates or updates an existing Group Matrix
GroupExtended_Delete Removes an existing Group Matrix. Can only be removed if no association exists to the group (activity, role or user association)
Holiday_Create Create a new calendar holiday associated to an existing calendar.
Holiday_CreateOrUpdate Action to create or update an event of a calendar
Holiday_Delete Deletes an existiing calendar holiday
Holiday_Update Update an existiing calendar holiday
Hostname_Get Gets Server Hostname
ImportUserHierarchy_GetSample Get a sample of the file content to perform an import
ImportUserHierarchy_GetStatus Check the status of an import request
Lookup_GetEntityRecords Lookup an Entity
Lookup_GetExtraFieldRecords Lookup an Extra field value
NonWorkingDay_Create Create a new calendar non working day associated to an existing calendar
NonWorkingDay_CreateOrUpdate Action to create or update a non working day associated to an existing calendar
NonWorkingDay_Delete Deletes an existiing calendar non working day
NonWorkingDay_Update Updates an existiing calendar non working day
NotificationsEngine_InitializeStaging It will mark all entries as deleted for the staging process after only import the active ones
PreDefinedTemplate_Create Creates a PredefinedTemplate object
PreDefinedTemplate_CreateOrUpdate Creates or updates a PredefinedTemplate object
PreDefinedTemplate_GetAll Gets all predefined templates
PreDefinedTemplate_GetById Gets a predefined template
PreDefinedTemplate_Update Updates a PredefinedTemplate object
Resource_CreateOrUpdate Creates or Updates a Resource
Resource_Delete Deletes a Resource
Resource_GetById Gets a Resource by Id
Resource_Purge Resource hard delete
Resources_GetAll Gets All Resources
Resources_InitializeStaging It will mark all entries as deleted for the staging process after only import the active ones
Rule_Create Create a Rule record
Rule_CreateOrUpdate Create or update a Rule record
Rule_Delete Deletes a whole rule
Rule_Update Update a Rule record
RuleGroup_Create Create a Rule Group record
RuleGroup_CreateOrUpdate Create or update a Rule Group record
RuleGroup_Delete Deletes a Rule Group
RuleGroup_DeleteAllByRuleId Deletes all Rule Group from a Rule
RuleGroup_Update Update a Rule Group record
RuleGroupOutput_CreateOrUpdate Create or update a Rule Group Output record
RuleLine_CreateOrUpdate Creates or updates a Rule Line
RuleLine_Delete Deletes a RuleLine
Rules_GetAll Get all rules available
Rules_GetById Get a rule by Id
Rules_InitializeStaging It will mark all entries as deleted for the staging process after only import the active ones
RulesGroup_GetAll Get all RuleGroups from a Rule
RulesOperator_GetBySettingType Returns the operations available for the respective setting type
SampleUser_CreateOrUpdate Create sample users (verifiy if is a second publish and disable all users before create news) and associate to its role and to its group (if applicable).
Setting_ConvertSetting Converts a Setting value to an CreateOrUpdate structure
Setting_CreateOrUpdate Public action that enables to create or update a setting
Setting_Delete Public action that deletes a setting
Setting_DeleteList Public action that deletes a list of settings
Setting_GetById Gets a Setting by it's Id
Setting_Purge Public action to hard delete a setting
SettingType_GetByColumnType Gets the attribute setting type
Tag_CreateOrUpdate Enables to create or update a Tag instance in the Tag entity
UserExtended_CreateOrUpdate Creates or updates an User extended record
UserHierarchy_Import Submits a requests to import user's hierarchy
Structure Description
BusinessEntity_View View for business entities
BusinessEntityAttr_View View for business entities attributes
Calendar_Create Public structure to create a new Calendar
Calendar_Update Public structure to update an existing Calendar
CaseAction_CreateOrUpdate Public structure to create or update a Case Workflow Action
CaseAction_View View for Case Workflow Action
CaseConfigurationBootstrap Holds the bootstrap data
CaseDefinition_Create Public structure to create a new case definition
CaseDefinition_CreateOrUpdate Public structure to create a new case definition or to update an existing case definition
CaseDefinition_Details Public structure that contains the case defintion details
CaseDefinition_FilterResults Filter Serch Structure
CaseStateMachine_Create Public structure for state machine creation
CaseStateMachine_CreateOrUpdate Structure to enable case state machine creation or update
CaseStateMachine_Details Case State Machine Details
CaseStatus_Create Public structure to create a new status
CaseStatus_CreateOrUpdate Public structure to create or update a status
CaseStatus_Details Case Status Detail
CaseTag_Create Public structure that enables to create CaseTage instances
Delegation_Create Holds a Delegation entry to be created
Delegation_Update Holds a Delegation details for update
EmailTemplate_CreateOrUpdate Represents a EmailTemplate object to be updated
EmailTemplate_View Represents a EmailTemplate object
Entity_Lookup Entity to lookup FK
Espace_Detail Public structure to hold espace details
FilterResults Filter Search Structure
FilterResults_Espace Filter Search Structure
FilterResults2 Filter Search Structure
Group_Details Public structure with system entity group details
GroupExtended_CreateOrUpdate Public structure to update an existing Group extended
HEMessage
Holiday_Create Public structure to create a new Calendar Holiday
Holiday_Update Public structure to update an existing Calendar Holiday
NonWorkingDay_Create Public structure to create a new Calendar Non Working Day
NonWorkingDay_Update Public structure to update an existing Calendar Non Working Day
PreDefinedTemplate_CreateOrUpdate View to create or update a PreDefined Template
PreDefinedTemplate_View View of a PreDefined Template
ProcessDefinition_Details Contains the generic details for process definition
Resource_CreateOrUpdate Structure to create or update a Resource
Resource_View Represents a Resource
Rule_CreateOrUpdate Structure to create/update a rule
Rule_View Structure with Rules fields
RuleAttribute_CreateOrUpdate Structure to create or update a Rule Attribute
RuleAttribute_View Structure with Rule Attribute fields
RuleConfig Represents a Rule configuration
RuleGroup_CreateOrUpdate Public structure to create or update a rule group
RuleGroup_View Structure with Rule Groups fields
RuleGroupOutput_CreateOrUpdate Structure to create or update a Rule Group Output
RuleGroupOutput_View Structure with RuleGroupOutput fields
RuleLine_CreateOrUpdate Structure to create or update a Rule Line
RuleLine_View Structure with Rule Line fields
Setting_CreateOrUpdate Public structure to create or update a setting
Setting_Value Public structure with the possible values for a setting
Tag_CreateOrUpdate Public structure that enables to create or update tag instances
UserExtended_CreateOrUpdate User extended create or update structure

Actions

BootstrapCaseConfiguration

Bootstraps the case configuration

Inputs

CaseConfigurationBootstrap
Type: mandatory, CaseConfigurationBootstrap.
Case Configuration Bootstrap

Calendar_Create

Action to create a new calendar

Inputs

CalendarCreateRec
Type: mandatory, Calendar_Create.
The calendar entity record.

Outputs

CalendarId
Type: Calendar Identifier.
The calendar identifier.

Calendar_CreateOrUpdate

Action to create or update a calendar

Inputs

CalendarRec
Type: mandatory, Calendar_Update.
The calendar entity record.

Outputs

CalendarId
Type: Calendar Identifier.
The calendar database identifier.

Calendar_Delete

Deletes an existiing calendar

Inputs

CalendarId
Type: mandatory, Calendar Identifier.
Calendar Identifier

Calendar_Update

Update an existing calendar

Inputs

CalendarUpdateRec
Type: mandatory, Calendar_Update.
The calendar update details record.

CaseAction_Bootstrap

Bootstraps the list of Case Workflow Actions

Inputs

CaseDefinitionId
Type: mandatory, CaseDefinition Identifier.
If defined will only inactive the entries for that case definition
CaseAction_CreateOrUpdateLst
Type: mandatory, CaseAction_CreateOrUpdate List.
List of workflow actions to bootstrap

CaseDefinition_CheckValidStatus

Checks if the status is valid for a specific case definition

Inputs

CaseDefinitionId
Type: mandatory, CaseDefinition Identifier.
Case Definition Identifier
StatusId
Type: mandatory, CaseStatus Identifier.
Case Status Identifier

Outputs

IsValid
Type: Boolean.
True if the status is valid False otherwise

CaseDefinition_Create

Creates a new case definition

Inputs

CaseDefinitionCreateRec
Type: mandatory, CaseDefinition_Create.
Case Definition Details

Outputs

CaseDefinitionId
Type: CaseDefinition Identifier.
Case Definition Identifier

CaseDefinition_CreateOrUpdate

Creates or updates a case definition

Inputs

CaseDefinitionRec
Type: mandatory, CaseDefinition_CreateOrUpdate.
Case Definition Details

Outputs

CaseDefinitionId
Type: CaseDefinition Identifier.
Case Definition Identifier

CaseDefinition_Delete

Deletes an existing case definition

Inputs

CaseDefinitionId
Type: optional, CaseDefinition Identifier.
Case Definition Identifier

CaseDefinition_GetActions

Gets the actions associated to a case definition

Inputs

CaseDefinitionId
Type: mandatory, CaseDefinition Identifier.
Case Definition Identifier

Outputs

CaseAction_ViewList
Type: CaseAction_View List.
List of workflow actions

CaseDefinition_GetAll

Gets the list of active CaseDefinitions

Inputs

FilterResults
Type: mandatory, CaseDefinition_FilterResults.
Filter Results

Outputs

CaseDefinitionDetailsList
Type: CaseDefinition_Details List.
List of CaseDefinition details
TotalResults
Type: Long Integer.
Number of total case definition results

CaseDefinition_GetById

Gets a specific Case Definition by case identifier

Inputs

CaseDefinitionId
Type: mandatory, CaseDefinition Identifier.
Case Definition Identifier

Outputs

CaseDefinitionDetail
Type: CaseDefinition_Details.
Case Definition details

CaseDefinition_GetDetailByProcessDefinitionId

Gets the Case Definition details

Inputs

ProcessDefinitionId
Type: mandatory, Process_Definition Identifier.
Process Definition Identifier

Outputs

CaseDefinitionDetail
Type: CaseDefinition_Details.
Case Definition details

CaseDefinition_GetEligibleToPurge

Get the case definitions that are eligible to purge, ie, without any case instance and which application is also deleted

Outputs

CaseDefinitionDetailsList
Type: CaseDefinition_Details List.
List of CaseDefinition details

CaseDefinition_GetEntityId

Gets the associated entity identifier

Inputs

CaseDefinitionId
Type: mandatory, CaseDefinition Identifier.
Case Definition Identifier

Outputs

EntityId
Type: Entity Identifier.
Entity Identifier

CaseDefinition_GetInitialStatus

Gets the initial status for a given case definition.

Inputs

CaseDefinitionId
Type: mandatory, CaseDefinition Identifier.
Case Definition Identifier

Outputs

CaseStatusId
Type: CaseStatus Identifier.
Case status Identifier

CaseDefinition_GetProcessDefinitionId

Gets the associated process definition identifier

Inputs

CaseDefinitionId
Type: mandatory, CaseDefinition Identifier.
Case Definition Identifier

Outputs

ProcessDefinitionId
Type: Process_Definition Identifier.
Process Definition Identifier

CaseDefinition_GetProcessDefinitionList

Gets the list of process definitions associated with case definitions

Inputs

FilterResults
Type: mandatory, FilterResults.
Filter Results

Outputs

ProcessDefinitionDetailsList
Type: ProcessDefinition_Details List.
List about process definition
TotalResults
Type: Long Integer.
Number of total process definition SLA that match the criteiria

CaseDefinition_GetStatusList

Gets the list of all valid statuses for a given case definition.

Inputs

CaseDefinitionId
Type: mandatory, CaseDefinition Identifier.
Case Definition Identifier

Outputs

CaseStatusDetailsList
Type: CaseStatus_Details List.
List of status details

CaseDefinition_PreviewByProcessDefinition

Previews the keys for the CaseDefinition based on a ProcessDefinition

Inputs

ProcessDefinitionId
Type: mandatory, Process_Definition Identifier.
Process Definition Identifier

Outputs

ProcessName
Type: Text.
Process Name
EntityId
Type: Entity Identifier.
Entity Identifier

CaseDefinition_Purge

Purges a Case Definition

Inputs

CaseDefinitionId
Type: mandatory, CaseDefinition Identifier.
CaseDefinition Id

CaseDefinition_Update

Updates an existing case definition

Inputs

CaseDefinitionUpdateRec
Type: mandatory, CaseDefinition_CreateOrUpdate.
Case Definition Details

CaseStateMachine_Create

Creates a new State Machine entry

Inputs

CaseStateMachineCreateRec
Type: mandatory, CaseStateMachine_Create.
Case State Machine Details

Outputs

CaseStateMachineId
Type: CaseStateMachine Identifier.
Case State Machine Identifier

CaseStateMachine_CreateOrUpdate

Creates or updates a State Machine entry

Inputs

CaseStateMachineRec
Type: mandatory, CaseStateMachine_CreateOrUpdate.
Case State Machine Details

Outputs

CaseStateMachineId
Type: CaseStateMachine Identifier.
Case State Machine Identifier

CaseStateMachine_Purge

Purge a Case State Machine

Inputs

CaseStateMachineId
Type: mandatory, CaseStateMachine Identifier.
CaseStateMachineId

CaseStateMachine_Update

Updates an existing State Machine entry

Inputs

CaseStateMachineRec
Type: mandatory, CaseStateMachine_CreateOrUpdate.
Case State Machine Details

CaseStatus_Bootstrap

Will replace the existing case definiton statuses (or create if new) for a specific CaseDefinition

Inputs

CaseDefinitionId
Type: mandatory, CaseDefinition Identifier.
CaseStatusList
Type: mandatory, CaseStatus_CreateOrUpdate List.
Case Status List

CaseStatus_Create

Creates a new Case Status

Inputs

CaseStatusCreateRec
Type: mandatory, CaseStatus_Create.
Case Status Details

Outputs

CaseStatusId
Type: CaseStatus Identifier.
Case Status Identifier

CaseStatus_CreateOrUpdate

Creates or updates a Case Status

Inputs

CaseStatusRec
Type: mandatory, CaseStatus_CreateOrUpdate.
Case Status Details

Outputs

CaseStatusId
Type: CaseStatus Identifier.
Case Status Identifier

CaseStatus_Delete

Deletes a Case Status

Inputs

CaseStatusId
Type: mandatory, CaseStatus Identifier.
Case Status Identifier

CaseStatus_GetById

Gets the status details by identifier

Inputs

Id
Type: mandatory, CaseStatus Identifier.
Status Identifier

Outputs

CaseStatusDetail
Type: CaseStatus_Details.
The details of an existing status
CaseStateMachineDetailList
Type: CaseStateMachine_Details List.
State machine details

CaseStatus_Update

Updates an existing Case Status

Inputs

CaseStatusUpdateRec
Type: mandatory, CaseStatus_CreateOrUpdate.
Case Status Details

CaseTag_Create

Enables to create a CaseTag instance in the CaseTag entity

Inputs

CaseTagCreateRec
Type: mandatory, CaseTag_Create.
Details for the creation of a new CaseTag record

Outputs

CaseTagId
Type: CaseTag Identifier.
CaseTag Identifier

CheckApplicationStatus

Check the status of an application

Inputs

CaseDefinitionId
Type: mandatory, CaseDefinition Identifier.
CaseDefinition Id

Outputs

StatusId
Type: CaseDefinitionStatus Identifier.
CaseDefinitionStatus Id
Message
Type: Text.
Message

Delegation_Create

Creates a new Delegation

Inputs

DelegationCreateRec
Type: mandatory, Delegation_Create.
Delegation creation details

Outputs

DelegationId
Type: Delegation Identifier.
Id

Delegation_CreateOrUpdate

Creates or updates a delegation

Inputs

DelegationRec
Type: mandatory, Delegation_Update.
Delegation Record

Outputs

DelegationId
Type: Delegation Identifier.
Delegation Identifier

Delegation_Delete

Deletes an existing Delegation. Can only be removed by the user that created the delegation, if not it will raise an exception.

Inputs

DelegationId
Type: mandatory, Delegation Identifier.
Delegation identifier

Delegation_Update

Updates an existing Delegation. Can only be updated by the user that created the delegation, if not it will raise an exc

Inputs

DelegationUpdateRec
Type: mandatory, Delegation_Update.
Record

Email_ProcessPlaceholders

It will replace the placeholders by the actual case data

Inputs

CaseId
Type: mandatory, Case Identifier.
Case Id. CaseId or CaseDefinitionId/ObjectId must be fulfilled.
Text
Type: mandatory, Text.
Text to process
KeepUnknownTags
Type: optional, Boolean.
If True, tags that do no matches to a valid field will not be clear from the returned text.
IsPreviewMode
Type: optional, Boolean.
If is preview mode and CaseId empty sample values will be used

Outputs

TextProcessed
Type: Text.
Text replaced with the placeholders

EmailTemplate_Create

Creates an EmailTemplate object

Inputs

EmailTemplate_CreateOrUpdate
Type: mandatory, EmailTemplate_CreateOrUpdate.
EmailTemplate record

Outputs

EmailTemplateId
Type: EmailTemplate Identifier.
EmailTemplate Id

EmailTemplate_CreateOrUpdate

Creates or updates an EmailTemplate object

Inputs

EmailTemplate_CreateOrUpdate
Type: mandatory, EmailTemplate_CreateOrUpdate.
EmailTemplate record

Outputs

EmailTemplateId
Type: EmailTemplate Identifier.
EmailTemplate Id

EmailTemplate_GetAll

Gets all EmailTemplates that matches the search criteria

Inputs

FilterResults
Type: mandatory, FilterResults2.
Filter Results
CaseDefinitionId
Type: optional, CaseDefinition Identifier.
Case Definition Id
FetchBody
Type: optional, Boolean.
Is True, body content will also be retrieved

Outputs

EmailTemplateDetailsList
Type: EmailTemplate_View List.
EmailTemplates list
TotalResults
Type: Long Integer.
Number of total groups that match the criteiria

EmailTemplate_GetById

Gets a EmailTemplate by Id

Inputs

EmailTemplateId
Type: mandatory, EmailTemplate Identifier.
Email Template Id

Outputs

EmailTemplateDetailsList
Type: EmailTemplate_View.
EmailTemplates list

EmailTemplate_Update

Updates an EmailTemplate object

Inputs

EmailTemplate_CreateOrUpdate
Type: mandatory, EmailTemplate_CreateOrUpdate.
EmailTemplate record

EntityAttr_GetByGlobalKey

Gets the AttributeId based on it's GlobalKey

Inputs

GlobalKey
Type: mandatory, Text.
GlobalKey

Outputs

AttributeId
Type: Entity_Attr Identifier.
Attribute Id

Espace_GetForActivityScreen

Gets list of espaces that can have screens to an activity can be opened by

Inputs

FilterResults
Type: mandatory, FilterResults_Espace.
Filter Results

Outputs

EspaceDetailList
Type: Espace_Detail List.
Contains all espace details list
TotalResults
Type: Long Integer.
Number of total espace that meet the criteria

GetBusinessEntities

Gets the list of business entities based on a case definition

Inputs

CaseDefinitionId
Type: mandatory, CaseDefinition Identifier.
CaseDefinition Id

Outputs

BusinessEntities
Type: BusinessEntity_View List.
List of Entities

GetBusinessEntityAttributes

Gets the list of business entities attributes based on an entity

Inputs

CaseDefinitionId
Type: optional, CaseDefinition Identifier.
Case Definition Identifier
EntityId
Type: optional, Entity Identifier.
Entity Identifier
OnlyEligibleForUsers
Type: optional, Boolean.
If True, attributes that cannot be used on the engine rules or notification placeholder will be excluded (ex: Binary fields)
IncludePK
Type: mandatory, Boolean.
If true, the PK will be also returned
IncludeExtraAttributes
Type: mandatory, Boolean.
If true, extra attributes will be included if already configured to this CaseDefinitionId
IncludeRelated
Type: optional, Boolean.
If true, attributes from entities that have a FK to the biz entity will also be returned.

Outputs

BusinessEntityAttrs
Type: BusinessEntityAttr_View List.
Business Entity Attributes

GetSystemDefaultDaysToPurge

Gets the system sefault days to purge the case data

Outputs

Days
Type: Integer.
Number of Days

GlobalKey_Parse

Parses a GlobalKey

Inputs

GlobalKey
Type: mandatory, Text.
GlobalKey

Outputs

EspaceSSKey
Type: Text.
Espace SSKey
ObjectSSKey
Type: Text.
Local Object SSKey

Group_AssignGroupToUser

Assigns a user to a group

Inputs

GroupId
Type: mandatory, Group Identifier.
Group Identifier
UserId
Type: mandatory, User Identifier.
User Identifier

Group_GetGroupsToAssociate

Gets existing groups not associated with group extended that can be associated

Outputs

ListGroupDetails
Type: Group_Details List.
Group Details
TotalResults
Type: Long Integer.
Number of total groups that match the criteiria

Group_UnassignGroupFromUser

Removes the user association fromo a group

Inputs

GroupId
Type: mandatory, Group Identifier.
Group Identifier
UserId
Type: mandatory, User Identifier.
User Identifier

GroupExtended_CreateOrUpdate

Creates or updates an existing Group Matrix

Inputs

GroupExtendedRec
Type: mandatory, GroupExtended_CreateOrUpdate.
Group Extended Details

Outputs

GroupExtendedId
Type: GroupExtended Identifier.

GroupExtended_Delete

Removes an existing Group Matrix. Can only be removed if no association exists to the group (activity, role or user association)

Inputs

GroupExtendedId
Type: mandatory, GroupExtended Identifier.
Group Extended Identifier

Outputs

IsSuccess
Type: Boolean.
If the group has been deleted

Holiday_Create

Create a new calendar holiday associated to an existing calendar.

Inputs

HolidayCreateRec
Type: mandatory, Holiday_Create.
Calendar Holiday Creation Details

Outputs

HolidayId
Type: Holiday Identifier.
Holiday Identifier

Holiday_CreateOrUpdate

Action to create or update an event of a calendar

Inputs

CalendarHolidaytRec
Type: mandatory, Holiday_Update.
Calendar Holiday Details

Outputs

CalendarHolidayId
Type: Holiday Identifier.
The calendar holiday identifier

Holiday_Delete

Deletes an existiing calendar holiday

Inputs

HolidayId
Type: mandatory, Holiday Identifier.
Calendar Holiday Identifier

Holiday_Update

Update an existiing calendar holiday

Inputs

HolidayUpdateRec
Type: mandatory, Holiday_Update.
The calendar update details record.

Hostname_Get

Gets Server Hostname

Outputs

Hostaname
Type: Text.
Server hostname

ImportUserHierarchy_GetSample

Get a sample of the file content to perform an import

Inputs

TypeId
Type: mandatory, ImportFileType Identifier.
Type

Outputs

Content
Type: Binary Data.
Sample content
Filename
Type: Text.
Sample filename

ImportUserHierarchy_GetStatus

Check the status of an import request

Inputs

ImportId
Type: mandatory, Text.
Import Id Guid
ReturnErrors
Type: optional, Boolean.
If true, a list of errors for each record that failed will be returned.

Outputs

StatusId
Type: ImportDataStatus Identifier.
Import status
TotalProcessed
Type: Integer.
Total records that were processed
TotalErrors
Type: Integer.
Total records that were in error
ListOfErrors
Type: Text, Integer List.
List of erros (only returned in Return errors is set to True)

Lookup_GetEntityRecords

Lookup an Entity

Inputs

EntityId
Type: mandatory, Entity Identifier.
Entity Id
PkValue
Type: optional, Text.
PK value

Outputs

Entity_Lookups
Type: Entity_Lookup List.
Entity Records

Lookup_GetExtraFieldRecords

Lookup an Extra field value

Inputs

CaseDefinitionId
Type: mandatory, CaseDefinition Identifier.
Case Definition Identifier
ExtraFieldId
Type: mandatory, ExtraField Identifier.
Extra Field Identifier

Outputs

Entity_Lookups
Type: Entity_Lookup List.
Entity Records

NonWorkingDay_Create

Create a new calendar non working day associated to an existing calendar

Inputs

NonWorkingDayCreateRec
Type: mandatory, NonWorkingDay_Create.
Calendar Non Working Day Creation Details

Outputs

NonWorkingDayId
Type: NonWorkingDay Identifier.
Calendar Holiday Identifier

NonWorkingDay_CreateOrUpdate

Action to create or update a non working day associated to an existing calendar

Inputs

CalendarNonWorkingDaytRec
Type: mandatory, NonWorkingDay_Update.
The calendar non working day record

Outputs

CalendarNonWorkingDayId
Type: NonWorkingDay Identifier.
The calendar non working day identifier

NonWorkingDay_Delete

Deletes an existiing calendar non working day

Inputs

NonWorkingDayId
Type: mandatory, NonWorkingDay Identifier.
Calendar Non Working Day Identifier

NonWorkingDay_Update

Updates an existiing calendar non working day

Inputs

NonWorkingDayUpdateRec
Type: mandatory, NonWorkingDay_Update.
The calendar non working day update details record.

NotificationsEngine_InitializeStaging

It will mark all entries as deleted for the staging process after only import the active ones

Inputs

CaseDefinitionId
Type: optional, CaseDefinition Identifier.
If defined will only inactive the entries for that case definition

PreDefinedTemplate_Create

Creates a PredefinedTemplate object

Inputs

PreDefinedTemplate_CreateOrUpdate
Type: mandatory, PreDefinedTemplate_CreateOrUpdate.
PreDefinedTemplate record

Outputs

PreDefinedTemplateId
Type: PreDefinedTemplate Identifier.
PreDefinedTemplate Id

PreDefinedTemplate_CreateOrUpdate

Creates or updates a PredefinedTemplate object

Inputs

PreDefinedTemplate_CreateOrUpdate
Type: mandatory, PreDefinedTemplate_CreateOrUpdate.
PreDefinedTemplate record

Outputs

PreDefinedTemplateId
Type: PreDefinedTemplate Identifier.
PreDefinedTemplate Id

PreDefinedTemplate_GetAll

Gets all predefined templates

Inputs

LoadBody
Type: mandatory, Boolean.
Is True, body content will also be retrieved

Outputs

PreDefinedTemplateDetailList
Type: PreDefinedTemplate_View List.
List of PreDefined Templates

PreDefinedTemplate_GetById

Gets a predefined template

Inputs

PreDefinedTemplateId
Type: mandatory, PreDefinedTemplate Identifier.
PreDefinedTemplate Id

Outputs

PreDefinedTemplateDetail
Type: PreDefinedTemplate_View.
PreDefined Template

PreDefinedTemplate_Update

Updates a PredefinedTemplate object

Inputs

PreDefinedTemplate_CreateOrUpdate
Type: mandatory, PreDefinedTemplate_CreateOrUpdate.
PreDefinedTemplate record

Resource_CreateOrUpdate

Creates or Updates a Resource

Inputs

ResourceCreateOrUpdate
Type: mandatory, Resource_CreateOrUpdate.
Resource to create or update

Outputs

Id
Type: Resource Identifier.
Resource Id

Resource_Delete

Deletes a Resource

Inputs

Id
Type: mandatory, Resource Identifier.
Id

Resource_GetById

Gets a Resource by Id

Inputs

Id
Type: mandatory, Resource Identifier.
Id

Outputs

ResourceDetail
Type: Resource_View.
Resource detail

Resource_Purge

Resource hard delete

Inputs

Id
Type: mandatory, Resource Identifier.
Id

Resources_GetAll

Gets All Resources

Inputs

CaseDefinitionId
Type: optional, Text.
CaseDefinition Id
LoadBinaryData
Type: mandatory, Boolean.
If true, Binary data will also be loaded
OnlyActive
Type: optional, Boolean.
Only Active

Outputs

ResourceDetailsList
Type: Resource_View List.
List of Resource

Resources_InitializeStaging

It will mark all entries as deleted for the staging process after only import the active ones

Inputs

CaseDefinitionId
Type: optional, Text.
If defined will only inactive the entries for that case definition

Rule_Create

Create a Rule record

Inputs

RuleRec
Type: mandatory, Rule_CreateOrUpdate.
Rule record

Outputs

Rule
Type: Rule_View.
Rule record created or updated

Rule_CreateOrUpdate

Create or update a Rule record

Inputs

RuleRec
Type: mandatory, Rule_CreateOrUpdate.
Rule record

Outputs

Rule
Type: Rule_View.
Rule record created or updated

Rule_Delete

Deletes a whole rule

Inputs

RuleId
Type: mandatory, Rule Identifier.
Rule Id

Rule_Update

Update a Rule record

Inputs

RuleRec
Type: mandatory, Rule_CreateOrUpdate.
Rule record

Outputs

Rule
Type: Rule_View.
Rule record created or updated

RuleGroup_Create

Create a Rule Group record

Inputs

RuleGroup_Record
Type: mandatory, RuleGroup_CreateOrUpdate.
RuleGroup record

Outputs

Id
Type: RuleGroup Identifier.
RuleGroup Id

RuleGroup_CreateOrUpdate

Create or update a Rule Group record

Inputs

RuleGroup_Record
Type: mandatory, RuleGroup_CreateOrUpdate.
RuleGroup record

Outputs

Id
Type: RuleGroup Identifier.
RuleGroup Id

RuleGroup_Delete

Deletes a Rule Group

Inputs

RuleGroupId
Type: mandatory, RuleGroup Identifier.
RuleGroup Id

RuleGroup_DeleteAllByRuleId

Deletes all Rule Group from a Rule

Inputs

RuleId
Type: mandatory, Rule Identifier.
Rule Id

RuleGroup_Update

Update a Rule Group record

Inputs

RuleGroup_Record
Type: mandatory, RuleGroup_CreateOrUpdate.
RuleGroup record

RuleGroupOutput_CreateOrUpdate

Create or update a Rule Group Output record

Inputs

RuleGroupOutputRec
Type: mandatory, RuleGroupOutput_CreateOrUpdate.
RuleGroupOutput record

Outputs

RuleGroupOutput_View
Type: RuleGroupOutput_View.
RuleGroupOutput record created or updated

RuleLine_CreateOrUpdate

Creates or updates a Rule Line

Inputs

RuleLineRec
Type: mandatory, RuleLine_CreateOrUpdate.
RuleLine record

Outputs

RuleLine_View
Type: RuleLine_View.
RuleLine record created or updated

RuleLine_Delete

Deletes a RuleLine

Inputs

RuleLineId
Type: mandatory, RuleLine Identifier.
RuleLine Id

Rules_GetAll

Get all rules available

Inputs

CaseDefinitionId
Type: mandatory, CaseDefinition Identifier.
Case Definition Id

Outputs

RulesLst
Type: Rule_View List.
Rules list

Rules_GetById

Get a rule by Id

Inputs

RuleId
Type: mandatory, Rule Identifier.
Rule Id

Outputs

Rule
Type: Rule_View.
Rule record

Rules_InitializeStaging

It will mark all entries as deleted for the staging process after only import the active ones

Inputs

CaseDefinitionId
Type: optional, CaseDefinition Identifier.
If defined will only inactive the entries for that case definition

RulesGroup_GetAll

Get all RuleGroups from a Rule

Inputs

RuleId
Type: optional, Rule Identifier.
Rule Id
RuleGroupId
Type: optional, RuleGroup Identifier.
RuleGroup Id

Outputs

RuleGroups
Type: RuleGroup_View List.
RuleGroups record list

RulesOperator_GetBySettingType

Returns the operations available for the respective setting type

Inputs

SettingTypeId
Type: mandatory, SettingType Identifier.
SettingType Id

Outputs

RuleOperators
Type: RuleOperator List.
List of permited Rule Operations

SampleUser_CreateOrUpdate

Create sample users (verifiy if is a second publish and disable all users before create news) and associate to its role and to its group (if applicable).

Inputs

CaseDefinitionId
Type: mandatory, CaseDefinition Identifier.
Case Definition Id
RequesterGroupId
Type: mandatory, GroupExtended Identifier.
Requester Group Id
OperatorGroupsId
Type: mandatory, GroupExtended Identifier List.
Groups to associate the user to

Setting_ConvertSetting

Converts a Setting value to an CreateOrUpdate structure

Inputs

SettingValue
Type: mandatory, Setting_Value.
Setting properties

Outputs

SettingCreateOrUpdate
Type: Setting_CreateOrUpdate.
Setting details after conversion

Setting_CreateOrUpdate

Public action that enables to create or update a setting

Inputs

SettingRec
Type: mandatory, Setting_CreateOrUpdate.
Details to create or update a setting

Outputs

SettingId
Type: Setting Identifier.
Setting Id

Setting_Delete

Public action that deletes a setting

Inputs

SettingId
Type: mandatory, Setting Identifier.
Setting Id

Setting_DeleteList

Public action that deletes a list of settings

Inputs

SettingIds
Type: mandatory, Setting Identifier List.
Setting Id

Setting_GetById

Gets a Setting by it's Id

Inputs

SettingId
Type: mandatory, Setting Identifier.
Setting Id

Outputs

SettingValue
Type: Setting_Value.
Setting record

Setting_Purge

Public action to hard delete a setting

Inputs

SettingId
Type: mandatory, Setting Identifier.
Setting Id

SettingType_GetByColumnType

Gets the attribute setting type

Inputs

AttributeId
Type: optional, Entity_Attr Identifier.
Attribute Id
AttributeType
Type: optional, Text.
rt Type (from Entity_Attr)
EvaluateFKTargetType
Type: mandatory, Boolean.
If true, when the Attribute it's a FK will check the basic type of the Attribute

Outputs

SettingTypeId
Type: SettingType Identifier.
SettingType Id
IsFK
Type: Boolean.
If true, the Attribute it's a FK
TargetEntityId
Type: Entity Identifier.
EntityId, only calculated then it's a FK and EvaluateFKTargetType is set to True

Tag_CreateOrUpdate

Enables to create or update a Tag instance in the Tag entity

Inputs

TagCreateRec
Type: mandatory, Tag_CreateOrUpdate.
Details for the creation of a new Tag record

Outputs

TagId
Type: Tag Identifier.
Tag Identifier

UserExtended_CreateOrUpdate

Creates or updates an User extended record

Inputs

UserExtendedRec
Type: mandatory, UserExtended_CreateOrUpdate.
User extended info

UserHierarchy_Import

Submits a requests to import user's hierarchy

Inputs

IsIgnoreEmpty
Type: optional, Boolean.
If there is a reporter not filled in if is true, should not clear the value for the user. If false, should clear the reporter.
Content
Type: mandatory, Binary Data.
Binary content
ContentTypeId
Type: mandatory, ImportFileType Identifier.
ContentTypeId

Outputs

ImportId
Type: Text.
Import request Guid

Structures

BusinessEntity_View

View for business entities

Attributes

EntityId
Type: Entity Identifier.
Entity Id
Name
Type: Text.
Name

BusinessEntityAttr_View

View for business entities attributes

Attributes

AttributeName
Type: Text.
Entity Attribute Name
AttributeId
Type: Entity_Attr Identifier.
Entity Attribute Id
EntityName
Type: Text.
Entity Name
EntityId
Type: Entity Identifier.
Entity Id
AttrLabel
Type: Text.
Attribute Label
Label
Type: Text.
Label to be displayed in the UI
ExtraFieldId
Type: ExtraField Identifier.
Extra field identifier
FollowFK
Type: Boolean.
If it's a FK follow the FK to fetch the value
IsFromBusinessEntity
Type: Boolean.
Is From Business Entity

Calendar_Create

Public structure to create a new Calendar

Attributes

Id
Type: Calendar Identifier.
Calendar Identifier
Name
Type: Text (50).
Description
Description
Type: Text (200).
Description
WorkingHourStart
Type: Time.
Working Hour Start
WorkingHourEnd
Type: Time.
Working Hour Start
TimezoneId
Type: Timezone Identifier.
Timezone for calendar

Calendar_Update

Public structure to update an existing Calendar

Attributes

Id
Type: Calendar Identifier.
Calendar Identifier
Name
Type: Text (50).
Name
Description
Type: Text (200).
Description
WorkingHourStart
Type: Time.
Working Hour Start
WorkingHourEnd
Type: Time.
Working Hour Start
TimezoneId
Type: Timezone Identifier.
Timezone for calendar
IsActive
Type: Boolean.
If is active

CaseAction_CreateOrUpdate

Public structure to create or update a Case Workflow Action

Attributes

Id
Type: CaseAction Identifier.
Identifier
Label
Type: Text (100).
Label
CaseDefinitionId
Type: CaseDefinition Identifier.
Case Definition Id
CaseStatusId
Type: CaseStatus Identifier.
Case Status Id
IsActive
Type: Boolean.

CaseAction_View

View for Case Workflow Action

Attributes

Id
Type: Text (36).
Identifier
Label
Type: Text (100).
Label
CaseDefinitionId
Type: CaseDefinition Identifier.
Case Definition Id
CaseStatusId
Type: CaseStatus Identifier.
Case Status Id
IsActive
Type: Boolean.
If the record is active

CaseConfigurationBootstrap

Holds the bootstrap data

Attributes

CaseDefinition
Type: CaseDefinition_CreateOrUpdate.
Case Definition
RuleConfigList
Type: RuleConfig List.
Rule Config List
GroupMatrixRecList
Type: GroupExtended_CreateOrUpdate List.
Group extended Details
StatusList
Type: CaseStatus_CreateOrUpdate List.
List of status to create or update
CaseActionList
Type: CaseAction_CreateOrUpdate List.
List of workflow actions to bootstrap
EmailNotificationList
Type: EmailTemplate_CreateOrUpdate List.
Notifications emails list
CaseResourceList
Type: Resource_CreateOrUpdate List.
EspaceId
Type: Espace Identifier.
Conf module Id of the end user app
CreateSampleUsers
Type: Boolean.
If it's to create sample users
HasRequesterManager
Type: Boolean.
If True, the application has associated requester manager (user hierarchy). Enables to create requester manager sample user.
Requester_RoleId
Type: Role Identifier.
Requester Role Id
Operator_RoleId
Type: Role Identifier.
Operator Role Id
Admin_RoleId
Type: Role Identifier.
Administrator Role Id

CaseDefinition_Create

Public structure to create a new case definition

Attributes

Id
Type: CaseDefinition Identifier.
Case Identifier
Name
Type: Text (50).
Case Name
Description
Type: Text (200).
Case description
EntityId
Type: Entity Identifier.
Entity Id
CalendarId
Type: Calendar Identifier.
Associated calendar identifier
PurgeTypeId
Type: PurgeType Identifier.
Option of purge type for current case definition
DaysToPurge
Type: Integer.
After a case is closed, number of days to keep the data in the system until being deleted.
< 0 : Never purge
0 : Use system defaults
> 0 : number of days
DaysToProcessPurge
Type: Integer.
After a case is closed, number of days to keep the process data in the system until being deleted.
IsAccessControl
Type: Boolean.
If the case definition is under access control
StatusId
Type: CaseDefinitionStatus Identifier.
Case definition status Id

CaseDefinition_CreateOrUpdate

Public structure to create a new case definition or to update an existing case definition

Attributes

Id
Type: CaseDefinition Identifier.
Case Identifier
Name
Type: Text (50).
Case Name
Description
Type: Text (200).
Case description
EntityId
Type: Entity Identifier.
Entity Id
CalendarId
Type: Calendar Identifier.
Associated calendar identifier
IsAccessControl
Type: Boolean.
If the case definition is under access control
PurgeTypeId
Type: PurgeType Identifier.
Option of purge type for current case definition
DaysToPurge
Type: Integer.
After a case is closed, number of days to keep the data in the system until being deleted.
< 0 : Never purge
0 : Use system defaults
> 0 : number of days
DaysToProcessPurge
Type: Integer.
After a case is closed, number of days to keep the process data in the system until being deleted.
StatusId
Type: CaseDefinitionStatus Identifier.
Case definition status Id
IsActive
Type: Boolean.
If the case is active

CaseDefinition_Details

Public structure that contains the case defintion details

Attributes

Id
Type: CaseDefinition Identifier.
Case Identifier
Name
Type: Text (50).
Case Name
Description
Type: Text (200).
Case description
ProcessDefinitionId
Type: Process_Definition Identifier.
Process Definition Id
EntityId
Type: Entity Identifier.
Entity Id
CalendarId
Type: Calendar Identifier.
Associated calendar identifier
IsAccessControl
Type: Boolean.
If the case definition is under access control
ProcessDefinitionGlobalKey
Type: Text.
ProcessDefinition GlobalKey
EntityGlobalKey
Type: Text.
Entity GlobalKey
PurgeTypeId
Type: PurgeType Identifier.
Option of purge type for current case definition
DaysToPurge
Type: Integer.
After a case is closed, number of days to keep the data in the system until being deleted.
< 0 : Never purge
0 : Use system defaults
> 0 : number of days
DaysToProcessPurge
Type: Integer.
After a case is closed, number of days to keep the process data in the system until being deleted.
StatusId
Type: CaseDefinitionStatus Identifier.
Case definition status Id
IsActive
Type: Boolean.
If the case definition is active

CaseDefinition_FilterResults

Filter Serch Structure

Attributes

PageNumber
Type: Integer.
Page number
MaxResultsPerPage
Type: Integer.
Number of results per page
OnlyActive
Type: Boolean.
Only active results
CaseName
Type: Text (50).
Case definition name

CaseStateMachine_Create

Public structure for state machine creation

Attributes

Id
Type: CaseStateMachine Identifier.
Status Machine Unique Text Identifier
CaseStatusId
Type: CaseStatus Identifier.
CaseStatus identifier
NextCaseStatusId
Type: CaseStatus Identifier.
The next status transition

CaseStateMachine_CreateOrUpdate

Structure to enable case state machine creation or update

Attributes

Id
Type: CaseStateMachine Identifier.
Status Machine Unique Text Identifier
CaseStatusId
Type: CaseStatus Identifier.
CaseStatus identifier
NextCaseStatusId
Type: CaseStatus Identifier.
The next case status transition
IsActive
Type: Boolean.
True if Status transition is active, false otherwise

CaseStateMachine_Details

Case State Machine Details

Attributes

Id
Type: CaseStateMachine Identifier.
Status Machine Unique Text Identifier
CaseStatusId
Type: CaseStatus Identifier.
CaseStatus identifier
NextCaseStatusId
Type: CaseStatus Identifier.
The next case status transition
IsActive
Type: Boolean.
True if status transition is active, false otherwise

CaseStatus_Create

Public structure to create a new status

Attributes

Id
Type: CaseStatus Identifier.
Status Unique Text Identifier
CaseDefinitionId
Type: CaseDefinition Identifier.
Case Unique Text Identifier
Name
Type: Text (50).
Status logical name
Alias
Type: Text (50).
Status alias name
IsInitial
Type: Boolean.
If the status is a initial
IsTerminal
Type: Boolean.
If the status is a terminal

CaseStatus_CreateOrUpdate

Public structure to create or update a status

Attributes

Id
Type: CaseStatus Identifier.
Status Unique Identifier
CaseDefinitionId
Type: CaseDefinition Identifier.
Case Unique Text Identifier
Name
Type: Text (50).
Status logical name
Alias
Type: Text (50).
Status alias name
IsInitial
Type: Boolean.
If the status is a initial
IsTerminal
Type: Boolean.
If the status is a terminal
IsActive
Type: Boolean.
True if status is active, false otherwise

CaseStatus_Details

Case Status Detail

Attributes

Id
Type: CaseStatus Identifier.
Status Unique Text Identifier
CaseDefinitionId
Type: CaseDefinition Identifier.
Case Unique Text Identifier
Name
Type: Text (50).
Status logical name
Alias
Type: Text (50).
Status alias name
IsInitial
Type: Boolean.
If the status is a initial
IsTerminal
Type: Boolean.
If the status is a terminal
IsActive
Type: Boolean.
True if status is active, false otherwise

CaseTag_Create

Public structure that enables to create CaseTage instances

Attributes

Id
Type: CaseTag Identifier.
CaseId
Type: Case Identifier.
TagId
Type: Tag Identifier.

Delegation_Create

Holds a Delegation entry to be created

Attributes

From
Type: Date.
Initial date of delegation
To
Type: Date.
Final date of delegation
FromUserId
Type: User Identifier.
Delegation UserId
FromGroupId
Type: Group Identifier.
Delegation GroupId (FromGroupId or FromGroupMatrixId must be set)
FromGroupExtendedId
Type: GroupExtended Identifier.
Group Extended Id (FromGroupId or FromGroupMatrixId must be set)
ToUserId
Type: User Identifier.
Delegated UserId
IsActive
Type: Boolean.
If is active

Delegation_Update

Holds a Delegation details for update

Attributes

DelegationId
Type: Delegation Identifier.
Delegation Identifier
From
Type: Date.
Initial date of delegation
To
Type: Date.
Final date of delegation
FromUserId
Type: User Identifier.
Delegation UserId
FromGroupId
Type: Group Identifier.
Delegation GroupId (FromGroupId or FromGroupMatrixId must be set)
FromGroupExtendedId
Type: GroupExtended Identifier.
Group Extended Id (FromGroupId or FromGroupMatrixId must be set)
ToUserId
Type: User Identifier.
Delegated UserId
IsActive
Type: Boolean.
If the delegation is active

EmailTemplate_CreateOrUpdate

Represents a EmailTemplate object to be updated

Attributes

Id
Type: EmailTemplate Identifier.
Email Template Identifier
CaseDefinitionId
Type: CaseDefinition Identifier.
Case Definition Identifier
Name
Type: Text (20).
Name of the template
Subject
Type: Text (256).
The email subject
FromDisplayName
Type: Text (250).
Email From Name
FromEmail
Type: Email.
Email From
IsActive
Type: Boolean.
If is active
EmailBody
Type: Text (50000).
Email Body

EmailTemplate_View

Represents a EmailTemplate object

Attributes

Id
Type: EmailTemplate Identifier.
Email Template Identifier
CaseDefinitionId
Type: CaseDefinition Identifier.
Case Definition Identifier
Name
Type: Text (200).
Name of the template
Subject
Type: Text (256).
The email subject
FromDisplayName
Type: Text (250).
Email From Name
FromEmail
Type: Email.
Email From
IsActive
Type: Boolean.
If is active
EmailBody
Type: Text (50000).
Email Body
CreatedBy
Type: User Identifier.
Created DateTime
CreatedOn
Type: Date Time.
Created On
UpdatedBy
Type: User Identifier.
Updated by
UpdatedOn
Type: Date Time.
Updated On

Entity_Lookup

Entity to lookup FK

Attributes

Key
Type: Text.
Key
Value
Type: Text.
Value

Espace_Detail

Public structure to hold espace details

Attributes

EspaceId
Type: Espace Identifier.
Espace Id
EspaceKey
Type: Text (100).
Espace Key
Name
Type: Text (100).
Espace Name

FilterResults

Filter Search Structure

Attributes

PageNumber
Type: Integer.
Page number
MaxResultsPerPage
Type: Integer.
Number of results per page
OnlyActive
Type: Boolean.
Gets only active Status Set
CaseName
Type: Text.
Filter by Case Definition Name
OnlyWithCaseDefinition
Type: Boolean.
If only associated with a Case Definition

FilterResults_Espace

Filter Search Structure

Attributes

PageNumber
Type: Integer.
Page number
MaxResultsPerPage
Type: Integer.
Number of results per page
OnlyActive
Type: Boolean.
Only active results

FilterResults2

Filter Search Structure

Attributes

PageNumber
Type: Integer.
Page number
MaxResultsPerPage
Type: Integer.
Number of results per page
OnlyActive
Type: Boolean.
If only active results

Group_Details

Public structure with system entity group details

Attributes

GroupId
Type: Group Identifier.
Group Identifier
Name
Type: Text (100).
Group Name (from system entity Group)
Description
Type: Text (500).
Group Description

GroupExtended_CreateOrUpdate

Public structure to update an existing Group extended

Attributes

Id
Type: GroupExtended Identifier.
Group extended Identifier
GroupId
Type: Group Identifier.
Group Identifier
GroupTypeId
Type: GroupType Identifier.
Group Type (Requester, Operator, ...)
ParentId
Type: GroupExtended Identifier.
Parent Identifier
Name
Type: Text (100).
Group name (If not filled in will assume group name from system entity group)
SystemName
Type: Text (100).
Name for the systen entity Group
Description
Type: Text (500).
Group Description
CalendarId
Type: Calendar Identifier.
Calendar Identifier (optional)
IsActive
Type: Boolean.
If the group extened is active
HasCustomManagement
Type: Boolean.
Is it has customer management and should or not be visibile through users

HEMessage

Attributes

Id
Type: Text (256).
Unique Id of message
Message
Type: Text (4000).
The content of the message
Detail
Type: Text (5000).
Message details
HelpRef
Type: Integer.
Service Studio Help ID reference
ExtraInfo
Type: Text (5000).
Any extra information available
Type
Type: Text (25).
Message type
Submitable
Type: Boolean.
Is this message submitable

Holiday_Create

Public structure to create a new Calendar Holiday

Attributes

Id
Type: Holiday Identifier.
Calendar Holiday Identifier
CalendarId
Type: Calendar Identifier.
Calendar Identifier
Name
Type: Text (50).
Event Name
The text on an event's element
Date
Type: Date.
Required. The day where the event will occur
IsRecurrent
Type: Boolean.
If this event is recurrent

Holiday_Update

Public structure to update an existing Calendar Holiday

Attributes

Id
Type: Holiday Identifier.
Calendar Holiday Identifier
CalendarId
Type: Calendar Identifier.
Calendar Identifier
Name
Type: Text (50).
Event Name
The text on an event's element
Date
Type: Date.
Required. The day where the event will occur
IsRecurrent
Type: Boolean.
If this event is recurrent
IsActive
Type: Boolean.
If the event is active

NonWorkingDay_Create

Public structure to create a new Calendar Non Working Day

Attributes

Id
Type: NonWorkingDay Identifier.
Calendar Non Working Day Identifier
CalendarId
Type: Calendar Identifier.
Calendar Identifier
WeekDayId
Type: WeekDay Identifier.
No deal possible on this day

NonWorkingDay_Update

Public structure to update an existing Calendar Non Working Day

Attributes

Id
Type: NonWorkingDay Identifier.
Calendar Non Working Day Identifier
CalendarId
Type: Calendar Identifier.
Calendar Identifier
WeekDayId
Type: WeekDay Identifier.
No deal possible on this day
IsActive
Type: Boolean.
Indicates if its active

PreDefinedTemplate_CreateOrUpdate

View to create or update a PreDefined Template

Attributes

Id
Type: PreDefinedTemplate Identifier.
Identifier
Name
Type: Text (200).
Template name
Subject
Type: Text (256).
Template subject
Body
Type: Text (50000).
Template body
IsActive
Type: Boolean.
If is active

PreDefinedTemplate_View

View of a PreDefined Template

Attributes

Id
Type: PreDefinedTemplate Identifier.
Identifier
Name
Type: Text (200).
Template name
Subject
Type: Text (256).
Template subject
Body
Type: Text (50000).
Template body
IsActive
Type: Boolean.
If is active

ProcessDefinition_Details

Contains the generic details for process definition

Attributes

Id
Type: Process_Definition Identifier.
Process Definition Identifier
Label
Type: Text (100).
Activity Definition Label

Resource_CreateOrUpdate

Structure to create or update a Resource

Attributes

Id
Type: Resource Identifier.
Id
Filename
Type: Text (100).
Filename
Filetype
Type: Text (100).
Filetype
Size
Type: Integer.
In bytes
CaseDefinitionId
Type: Text (36).
CaseDefinition Id
IsActive
Type: Boolean.
If the record is active
Data
Type: Binary Data.
Binary Data

Resource_View

Represents a Resource

Attributes

Id
Type: Resource Identifier.
Id
Filename
Type: Text (100).
Filename
Filetype
Type: Text (100).
Filetype
Size
Type: Integer.
In bytes
CaseDefinitionId
Type: Text (36).
CaseDefinition Id
IsActive
Type: Boolean.
If the record is active
Data
Type: Binary Data.
Binary Data

Rule_CreateOrUpdate

Structure to create/update a rule

Attributes

Id
Type: Rule Identifier.
Rule Id
Name
Type: Text (50).
Rule Name
Description
Type: Text.
Rule description
CaseDefinitionId
Type: CaseDefinition Identifier.
Case Definition Id
RuleTypeId
Type: RuleType Identifier.
RuleType Id
IsExternal
Type: Boolean.
If true, the rule outcome will become from a REST call
ExternalURL
Type: Text (500).
Relative REST endpoint for external rules

Rule_View

Structure with Rules fields

Attributes

Id
Type: Rule Identifier.
Rule Id
Name
Type: Text.
Rule Name
Description
Type: Text.
Rule description
CaseDefinitionId
Type: CaseDefinition Identifier.
Case Definition Id
IsActive
Type: Boolean.
If the rule is active
LastUpdatedBy
Type: User Identifier.
Identify the user responsable for the record updated
LastUpdateOn
Type: Date Time.
Instant of the last record update
RuleType
Type: RuleType.
Rule Type
IsExternal
Type: Boolean.
If true, the rule outcome will become from a REST call
ExternalURL
Type: Text (500).
Relative REST endpoint for external rules
NumRulesGroup
Type: Integer.
Number of rule groups that this rule has

RuleAttribute_CreateOrUpdate

Structure to create or update a Rule Attribute

Attributes

Id
Type: RuleAttribute Identifier.
RuleAttribute Id
AttributeId
Type: Entity_Attr Identifier.
Attibute Id
ExtraFieldId
Type: ExtraField Identifier.
RuleAttributeTypeId
Type: RuleAttributeType Identifier.
RuleAttributeType Id
Setting_CreateOrUpdate
Type: Setting_CreateOrUpdate.
Setting record

RuleAttribute_View

Structure with Rule Attribute fields

Attributes

Id
Type: RuleAttribute Identifier.
RuleAttribute Id
AttributeId
Type: Entity_Attr Identifier.
Attibute Id
ExtraFieldId
Type: ExtraField Identifier.
RuleAttributeTypeId
Type: RuleAttributeType Identifier.
RuleAttributeType Id
GlobalKey
Type: Text.
GlobalKey (when it's a business field)
Setting_Value
Type: Setting_Value.
Setting record

RuleConfig

Represents a Rule configuration

Attributes

RuleView
Type: Rule_View.
Rule View
RuleGroups
Type: RuleGroup_View List.
Rule Groups

RuleGroup_CreateOrUpdate

Public structure to create or update a rule group

Attributes

Id
Type: RuleGroup Identifier.
RuleGroup Id
RuleId
Type: Rule Identifier.
Rule Id
Order
Type: Integer.
Order
Description
Type: Text.
Description

RuleGroup_View

Structure with Rule Groups fields

Attributes

Id
Type: RuleGroup Identifier.
RuleGroup Id
RuleId
Type: Rule Identifier.
Rule Id
Order
Type: Integer.
Order
Description
Type: Text.
Description
RuleLines
Type: RuleLine_View List.
RuleLines of this RuleGroup
RuleGroupOutput
Type: RuleGroupOutput_View.
Output of this RuleGroup

RuleGroupOutput_CreateOrUpdate

Structure to create or update a Rule Group Output

Attributes

Id
Type: RuleGroupOutput Identifier.
RuleGroupOutput Id
RuleGroupId
Type: RuleGroup Identifier.
RuleGroup Id
Setting_CreateOrUpdate
Type: Setting_CreateOrUpdate.
Setting record

RuleGroupOutput_View

Structure with RuleGroupOutput fields

Attributes

Id
Type: RuleGroupOutput Identifier.
RuleGroupOutput Id
RuleGroupId
Type: RuleGroup Identifier.
RuleGroup Id
Setting
Type: Setting_Value.
Setting record

RuleLine_CreateOrUpdate

Structure to create or update a Rule Line

Attributes

Id
Type: RuleLine Identifier.
RuleLine Id
RuleGroupId
Type: RuleGroup Identifier.
RuleGroup Id
RuleOperatorId
Type: RuleOperator Identifier.
RuleOperator Id
Order
Type: Integer.
Order
LeftAttribute
Type: RuleAttribute_CreateOrUpdate.
LeftAttribute record
RightAttribute
Type: RuleAttribute_CreateOrUpdate.
RightAttribute record

RuleLine_View

Structure with Rule Line fields

Attributes

Id
Type: RuleLine Identifier.
RuleLine Id
Order
Type: Integer.
Order
LeftAttribute
Type: RuleAttribute_View.
Left Rule Attribute
RightAttribute
Type: RuleAttribute_View.
Right Rule Attribute
RuleOperator
Type: RuleOperator.
Rule Operator

Setting_CreateOrUpdate

Public structure to create or update a setting

Attributes

Id
Type: Setting Identifier.
Setting Id
Name
Type: Text.
Setting name (optional)
SettingTypeId
Type: SettingType Identifier.
Setting type Id
Decimal
Type: Decimal (37, 0).
Decimal field
Integer
Type: Long Integer.
Integer field
LongInteger
Type: Long Integer.
LongInteger field
Text
Type: Text.
Text field
Date
Type: Date.
Date field
Time
Type: Time.
Time
Boolean
Type: Boolean.
Boolean field
IsActive
Type: Boolean.
True - is active, False - is not

Setting_Value

Public structure with the possible values for a setting

Attributes

Id
Type: Setting Identifier.
Setting Id
Name
Type: Text.
Setting name (optional)
SettingTypeId
Type: SettingType Identifier.
Setting type Id
Decimal
Type: Decimal (37, 0).
Decimal field
Integer
Type: Long Integer.
Integer field
LongInteger
Type: Long Integer.
LongInteger field
Text
Type: Text (50).
Text field
Date
Type: Date.
Date field
Time
Type: Time.
Time field
Boolean
Type: Boolean.
Boolean field

Tag_CreateOrUpdate

Public structure that enables to create or update tag instances

Attributes

Id
Type: Tag Identifier.
Tag identifier
Label
Type: Text (50).
Tag label

UserExtended_CreateOrUpdate

User extended create or update structure

Attributes

UserId
Type: User Identifier.
User Id
ManagerUserId
Type: User Identifier.
User's manager
GroupExtendedId
Type: GroupExtended Identifier.
Default user group
  • Was this article helpful?