Application - com.hornbill.servicemanager

Entities

The following entities are defined for this application

AccountStatus

There are no operations or events defined for the 'AccountStatus' entity.

Achievement

The following operations are defined for the 'Achievement' entity.

Operation	Description
addAchievement	For internal use only - This flowcode operation awards an achievement to the specified user.

AchievementImage

There are no operations or events defined for the 'AchievementImage' entity.

Assessment

The following operations are defined for the 'Assessment' entity.

Operation	Description
get	This flowcode is responsbile for returning the applicable Assessment(s) based on the provided type id
getAssessment	Load questions and answers for an assessment

AssessmentAnswers

The following operations are defined for the 'AssessmentAnswers' entity.

Operation	Description
get	This flowcode is responsible for returning all the applicable Assessment Answer(s)

AssessmentQuestions

The following operations are defined for the 'AssessmentQuestions' entity.

Operation	Description
get	This flowcode is responsible for returning all the applicable Assessment Question(s)

AssessmentTypes

The following operations are defined for the 'AssessmentTypes' entity.

Operation	Description
get	This flowcode is responsible for returning all the applicable Assessment Type(s)

Asset

The following operations are defined for the 'Asset' entity.

Operation	Description
addAsset	This flowcode operation is a component operation for the following flowcodes: addAssetComputer, addAssetComputerPeripheral, addAssetMobileDevice, addAssetNetworkDevice, addAssetPrinter, addAssetSoftware, addAssetTelecoms.
core_getProgressiveCaptureAssets	Progressive Capture Asset Details template FC in preparation for Progressive Capture 2 API support
createAsset	This flowcode operation creates an asset of the class passed in.
deleteAsset	This flowcode oepration deletes an asset from the system.
deleteAssets	Delete a list of Assets
export	This operation is used to export the assets list
getAssetsFiltered	This operation return a list of assets
getImageInfo	This flowcode load the info related to the asset image. If the asset has no image then return the info for the relevant asset type
getUserProfileAssets	This is the description text for this flowcode operation
linkAsset	This flowcode operation links an asset to another asset, request or other system entity.
linkAssets	This flowcode operation links an asset to another asset, request or other system entity.
loadAssetData	This flowcode load the asset data stored in the DB
loadLinkedEntities	This flowcode load the entities linked to the asset and their count
loadOptions	This flowcode loads the basic information required for the asset form, including the list of possible countries
searchAssetGlobal	Intended to be used by the global search feature in Collaboration. Each asset classes is searched in order to find the best results.
selfserviceGetAssetsByUser	This operation returns shared assets that the supplied user is a user of
smEnableSharedUsers	This flowcode enables shared users for an asset by setting the asset user id as 'shared' and adding any existing user as the initial shared user
smGetAssetsByUser	This operation returns shared assets that the supplied user is a user of
unlinkAsset	This flowcode operation unlinks an asset from another asset, request or other system entity.
updateAsset	This flowcode operation is a component operation for the following flowcodes: updateAssetComputer, updateAssetComputerPeripheral, updateAssetMobileDevice, updateAssetNetworkDevice, updateAssetPrinter, updateAssetSoftware, updateAssetTelecoms.
updateAsset2	This flowcode operation updates an asset of the class passed in.

AssetsBasic

The following operations are defined for the 'AssetsBasic' entity.

Operation	Description
addAssetBasic	This flowcode operation creates an asset of class 'AssetSoftware'.
updateAssetBasic	This flowcode operation updates an asset of class 'AssetSoftware'.

AssetsComputer

The following operations are defined for the 'AssetsComputer' entity.

Operation	Description
addAssetComputer	This flowcode operation creates an asset of class 'AssetComputer'.
updateAssetComputer	This flowcode operation updates an asset of class 'AssetComputer'.

AssetsComputerPeripheral

The following operations are defined for the 'AssetsComputerPeripheral' entity.

Operation	Description
addAssetComputerPeripheral	This flowcode operation creates an asset of class 'AssetComputerPeripheral'.
updateAssetComputerPeripheral	This flowcode operation updates an asset of class 'AssetComputerPeripheral'.

AssetsLinks

There are no operations or events defined for the 'AssetsLinks' entity.

AssetsMobileDevice

The following operations are defined for the 'AssetsMobileDevice' entity.

Operation	Description
addAssetMobileDevice	This flowcode operation creates an asset of class 'AssetMobileDevice'.
updateAssetMobileDevice	This flowcode operation updates an asset of class 'AssetMobileDevice'.

AssetsNetworkDevice

The following operations are defined for the 'AssetsNetworkDevice' entity.

Operation	Description
addAssetNetworkDevice	This flowcode operation creates an asset of class 'AssetNetworkDevice'.
updateAssetNetworkDevice	This flowcode operation updates an asset of class 'AssetNetworkDevice'.

AssetsPrinter

The following operations are defined for the 'AssetsPrinter' entity.

Operation	Description
addAssetPrinter	This flowcode operation creates an asset of class 'AssetPrinter'.
updateAssetPrinter	This flowcode operation updates an asset of class 'AssetPrinter'.

AssetsSoftware

The following operations are defined for the 'AssetsSoftware' entity.

Operation	Description
addAssetSoftware	This flowcode operation creates an asset of class 'AssetSoftware'.
updateAssetSoftware	This flowcode operation updates an asset of class 'AssetSoftware'.

AssetsTelecoms

The following operations are defined for the 'AssetsTelecoms' entity.

Operation	Description
addAssetTelecoms	This flowcode operation creates an asset of class 'AssetTelecoms'.
updateAssetTelecoms	This flowcode operation updates an asset of class 'AssetTelecoms'.

AssetsTypes

The following operations are defined for the 'AssetsTypes' entity.

Operation	Description
addType	This flowcode operation adds a new asset type. If an asset type with same name in the same class already exists then return an error message.
deleteType	This flowcode operation deletes an asset type. If there are assets or requests currently associated with the asset type then teh system will not be able to delete it.
getAssetClassAndType	This Flowcode is responsible for returning Asset Classes, Types, Status and Search Criteria Type
getImageInfo	This flowcode load the info related to the asset image. If the asset has no image then return the info for the relevant asset type
getTableMetaData	This flowcode operation returns a list of common and extended detail asset properties.
updateType	This flowcode operation updates an existing asset type. If an asset type with same name in the same class already exists then return an error message.

AssetSubstate

The following operations are defined for the 'AssetSubstate' entity.

Operation	Description
createAssetSubstate	Create an Asset Substate
deleteAssetSubstate	Delete a Product
getSubstatesMap	This flowcode return the asset substates gruped by stateID
updateAssetSubstate	Update the information for a substate

AssetUsers

The following operations are defined for the 'AssetUsers' entity.

Operation	Description
create	This flowcode will create a shared asset user entry to link a user to an asset
delete	This flowcode will delete one or all shared asset user entries such that they will no longer be a user of the asset
getSharedAssetIds	This operation return the IDs of the assets shared by the sharers. For example, if the input param sharer = [{"type": "User", id:"admin"},{"type": "Team", "id": "hornbill/servicemanager/"}], then this operation return the IDs of the assets shared with the user "admin" OR shared with the team "hornbill/servicemanager/"
read	This flowcode is responsbile for returning the list of users against a specific asset

Attachment

The following operations are defined for the 'Attachment' entity.

Operation	Description
addAttachmentToEntity	Add an attachment to an entity
removeAttachmentFromEntity	Remove an attachment from an entity

BoardCards

The following operations are defined for the 'BoardCards' entity.

Operation	Description
moveCard	This operation allows you to move a card to a new position within a list, or a position in another list, on a board
smAddCard	FlowCode that will add a comment to the top of the board list.
smAddCommentCard	FlowCode that will add a comment to the top of the board list.
smArchiveCard	Archive a card from a board
smEditCommentCard	FlowCode that will add a comment to the top of the board list.
smMoveCard	Move cards on a board

BoardMembers

The following operations are defined for the 'BoardMembers' entity.

Operation	Description
browse	This returns a set of records
create	This associates an entity to a board
delete	This will remove the board member record
update	This will update the membership record with new can modify value

Boards

The following operations are defined for the 'Boards' entity.

Operation	Description
addBoardComment	This operation allows you to add a comment onto a board
addBoardRequest	This operation allows you to add a request onto a board
addCardToBoard	This flowcode is responsible for adding either single or multiple Requests to a specific Board. It handles the addition, un-archiving and the detection of cards assigned to a particular board.
removeCardFromBoard	This flowcode is responsible is responisble for deleting (archiving) a particular card in a board
smAddListToBoard	This flowcode is responsible for adding a new List to a specific Board
smBoardLogs	Flowcode to get the total count of board card logs and display boards logs in sets of 10
smDeleteList	This flowcode is responsible for deleting a specific List from a specific Board
smEditList	This flowcode is responsible for editing the List of a specified Board
smGetBoardItems	This flowcode is responsible for getting all the Board Data items for the currently selected Board
smGetUserBoards	This flowcode returns the list of boards, and whether the user has right to edit

Bookmark

There are no operations or events defined for the 'Bookmark' entity.

BookmarkCategory

There are no operations or events defined for the 'BookmarkCategory' entity.

BookmarkHistory

There are no operations or events defined for the 'BookmarkHistory' entity.

BpmUiLauncher

There are no operations or events defined for the 'BpmUiLauncher' entity.

BusinessProcessInstance

There are no operations or events defined for the 'BusinessProcessInstance' entity.

Catalog

The following operations are defined for the 'Catalog' entity.

Operation	Description
addServiceToFavourites	- PROTOTYPE - Adds a service to Favourites - calling for app flowcode: catalogAddServiceToFavourites
getBulletinList	- PROTOTYPE - Returns a list of bulletins - calling for app flowcode: catalogGetBulletinList
getFAQList	- PROTOTYPE - Returns a list of FAQs - calling for app flowcode: catalogGetFAQList
getKnownIssueList	- PROTOTYPE - Returns a list of known issues - calling for app flowcode: catalogGetKnownIssueList
getMyServiceDomains	- PROTOTYPE - Returns a list of Service Domains that are used only based on My Services List - calling for app flowcode: catalogGetServiceList Also returns a property called serviceCount with the count of services for each domain If no services assigned, it will return a dummy domain called "other"
getMyServiceRequestList	- PROTOTYPE - Returns a list of My Service Requests (request records already raised) - calling for app flowcode: catalogGetMyServiceRequestList
getService	- PROTOTYPE - Returns a service - calling for app flowcode: catalogGetService
getServiceDomain	- PROTOTYPE - Returns a specific Service Domain includding the layour and style details
getServiceDomainLayout	- PROTOTYPE - Returns a specific Service Domain layout and style details. If service domain is not passed, it will return the generic sections.
getServiceDomains	- PROTOTYPE - Returns a list of enabled Service Domains includding the basic data of the related page
getServiceFAQ	- PROTOTYPE - Get Service FAQ
getServiceList	- PROTOTYPE - Returns a list of services - calling for app flowcode: catalogGetServiceList
getServiceRequest	- DEMO - Returns a Service Request
getServiceRequestList	- PROTOTYPE - Returns a list of Service Requests - calling for app flowcode: catalogGetServiceRequestList
homePageGet	- PROTOTYPE - Returns the Home Page
homePageSet	- PROTOTYPE - Inserts or Updates a Page
removeServiceFromFavourites	- PROTOTYPE - Removes a service from Favourites - calling for app flowcode: catalogRemoveServiceFromFavourites
searchService	- PROTOTYPE - Returns a list of services, Service Subtypes or/and existing service requests based on a query
setServiceDomain	- PROTOTYPE - Saves changes to a specific Service Domain
setServiceDomainCalendarEvent	- PROTOTYPE - Add or Update n Service Domain Event
setServiceFAQDislike	- PROTOTYPE - Sets Dislike flag to an FAQ
setServiceFAQLike	- PROTOTYPE - Sets Like flag to an FAQ
setServiceKnownIssueMeToo	- PROTOTYPE - Sets Known Issue Me To to TRUE or FALSE via the value property
submitServiceRequest	- DEMO - Returns a Service Request
unsetServiceDomainCalendarEvent	- PROTOTYPE - Removes a Service Domain Event

Catalogs

The following operations are defined for the 'Catalogs' entity.

Operation	Description
delete	This operation deletes a Catalog and it's associated translations.
getCatalogs	This operation returns the Catalogs against a particular Service.
getCurrentProgressiveCapture	This flowcode is repsonsible for getting the current Progressive Capture data
getVisibleCatalogs	This operation returns the Catalogs against a particular Service that are configured to be visible by Request Type. This operation is intended for the User App.
reorderCatalogs	This flowcode is responsible for re-arranging the Catalogs according to their specified Request Type
selfserviceGetVisibleCatalogs	This operation returns the Catalogs against a particular Service that are configured to be visible by Request Type. This operation is intended for the Portals.

CatalogSubscriptionExclusions

The following operations are defined for the 'CatalogSubscriptionExclusions' entity.

Operation	Description
catalogSubscriptionGet	This operation returns a list of a Catalog's subscribers.
excludeAll	This operation excludes all subscribers of a Service from a Catalog.
manage	This operation allows a Service user to control a Service subscriber's subscription to a Catalog.
revert	This operation reverts a Catalog's subscription back to mirror the Service's subscription (i.e. removes all exclusions).

ChangeCalendarRestrictions

The following operations are defined for the 'ChangeCalendarRestrictions' entity.

Operation	Description
actionChangeCalendarRestriction	This operation add/delete/update a change calendar restriction
getChangeCalendarRestriction	This operation return a set of change calendar restrictions
systemAddChangeCalendarRestriction	FOR INTERNAL USE ONLY: this operation add a change calendar restriction
systemDeleteChangeCalendarRestriction	FOR INTERNAL USE ONLY: this operation delete a change calendar restriction
systemGetChangeCalendarRestriction	FOR INTERNAL USE ONLY: this operation return the change calendar restrictions.
systemUpdateChangeCalendarRestriction	FOR INTERNAL USE ONLY: this operation update a change calendar restriction

ChangeRequests

The following operations are defined for the 'ChangeRequests' entity.

Operation	Description
logChangeRequest	This flowcode operation logs a Change Request using the provided parameters. Firstly it calls the component flowcode operation logRequest to actually log the change before updating the record with any extended table details. Finally it spawns a bpm process if a service id has been provided.
schedule	Schedule a Change Request
selfserviceLogChangeRequest	This flowcode operation logs a Service Request using the provided parameters. Firstly it calls the component flowcode operation logRequest to actually log the service request before updating the record with any extended table details. Finally it spawns a bpm process if a service id has been provided.
unSchedule	Operation to unschedule the Change request

Charts

The following operations are defined for the 'Charts' entity.

Operation	Description
addChart	This operation creates a new chart for a filter.
delete	This operation removes a chart from a custom view (i.e. Generic Filters).
smGetChartFilters	This operation returns Charts configuration for a filter that belongs to the logged on user.
smGetDashboardCharts	This operation returns the Requests data for the charts that are visible to a user.
smReorderCharts	This operation is now deprecated. Please use "DashboardCharts::fc_ops::reorder" operation instead.
updateChart	This operation updates a chart for a filter.

Colleagues

The following operations are defined for the 'Colleagues' entity.

Operation	Description
getColleagueManager	This operation returns Id of a colleague's manager.
getUsersByApp	This flowcode is responsible for returning a list of users who do or not have access to the supplied application

Contact

The following operations are defined for the 'Contact' entity.

Operation	Description
GetContainerId	Get the container id (Organisation) for the specified contact.
add	For internal use only - Add Contact by ID
addContact	DEPRECATED (use addContactNew)
addContact3	For internal use only - Add a New Contact This version 3 uses Organisation instead of container but still updates the containers data structure
addContact4	For internal use only - Add a New Contact
addContactNew	For internal use only - Add a New Contact
archive	For internal use only - This flowcode is responsible for accepting one or more contactIds and changing their status from active to archived
archiveContact	For internal use only - This flowcode is responsible for accepting one or more contactIds and changing their status from active to archived
changeOrg	For internal use only - Change the Contact's Organisation
get	For internal use only - Get Contact by ID
getList	For internal use only - Get a list of contacts
guestUpdateProfile	This flowcode allows an authorised guest to update only there own contact record
removeOrg	For internal use only - Remove the Contact's Organisation
sendSystemNotification	Send notification to user
unArchive	Updates the status of teh contact to be Active. Note that if the contact had access to the portal, this will not enable back to that state.
unarchiveContact	Updates the status of teh contact to be Active. Note that if the contact had access to the portal, this will not enable back to that state.
update	For internal use only - Update Contact
updateContact	DEPRECATED (Use updateContactNew)
updateContact3	For internal use only - Update Contact
updateContact4	For internal use only - Update Contact
updateContactNew	DEPRECATED - Use updateContact3 or changeOrg instead - For internal use only - Update Contact

Contact_extra

There are no operations or events defined for the 'Contact_extra' entity.

Contact_notes

There are no operations or events defined for the 'Contact_notes' entity.

ContactAccess

There are no operations or events defined for the 'ContactAccess' entity.

ContactOrgRequests

The following operations are defined for the 'ContactOrgRequests' entity.

Operation	Description
changeCancelRequestSetting	Create or change the cancellation request permission for Contacts
changeOrgRequestSetting	This operation sets a contact's visibility to their Organisation's Requests.

Container

The following operations are defined for the 'Container' entity.

Operation	Description
addChild	For internal use only
addContainer	This is the description text for this flowcode operation
getChildren	This is the description text for this flowcode operation
getChildrenCount	This is the description text for this flowcode operation
getContainer	For internal use only
getRelatedContainers	This is the description text for this flowcode operation
removeChild	This is the description text for this flowcode operation
removeContainer	This is the description text for this flowcode operation
removePermission	This is the description text for this flowcode operation
setPermission	This is the description text for this flowcode operation
updateContainer	This is the description text for this flowcode operation

ContainerPermissions

There are no operations or events defined for the 'ContainerPermissions' entity.

ContainerType

There are no operations or events defined for the 'ContainerType' entity.

Country

There are no operations or events defined for the 'Country' entity.

CoworkerLifecycle

There are no operations or events defined for the 'CoworkerLifecycle' entity.

CustomButtonSettings

There are no operations or events defined for the 'CustomButtonSettings' entity.

CustomList

There are no operations or events defined for the 'CustomList' entity.

DashboardCharts

The following operations are defined for the 'DashboardCharts' entity.

Operation	Description
create	This operation adds a chart to a user's dashboard.
delete	This operation remove a chart from a user's dashboard.
get	This operation returns the charts for a user's dashboard.
reorder	This operation reorders charts in a user's dashboard. When the position of a chart in a user's dashboard is changed, a plugin in the front-end provides the updated position of all charts.
update	This operation updates the configuration of a chart in a user's dashboard.

EntityAttachments

The following operations are defined for the 'EntityAttachments' entity.

Operation	Description
attachFile	DEPRECATED - Attach a file to the EntityAttachments
removeAttachment	DEPRECATED - Remove an attachment from the case
updateDescription	DEPRECATED - Update description of attachments

Faqs

The following operations are defined for the 'Faqs' entity.

Operation	Description
attachImage	This uploads an image for a given bulletin
deleteFaq	This flowcode is responsible for deleting either a particular FAQ translation of a particular FAQ or the entire FAQ and all its translations
entityAttachGetInfo	This flowcode return info about an attachment to an FAQ entity
getFaqs	This operation returns the Faqs that belong to a Service.
smSelfServiceGetFaqs	This operation returns the Faqs that belong to a Service.
updateFaqViewCount	This operation is now deprecated.

FaqsFeedback

The following operations are defined for the 'FaqsFeedback' entity.

Operation	Description
faqFeedback	This flowcode is responsible for updating a particular FAQs feedback i.e. Liking, Disliking or removing your Feedback

Favorite

There are no operations or events defined for the 'Favorite' entity.

GenericFilter

The following operations are defined for the 'GenericFilter' entity.

Operation	Description
adminChangeOwner	This operation changes the owner of the supplied View(s).
adminDeleteView	This operation deletes the supplied View(s).
smDeleteFilter	This operation allows a user to delete their View.
smGetCustomFilters	This operation is now deprecated. Please use "GenericFilter::fc_ops::smGetCustomFilters2" instead.
smGetCustomFilters2	Get a list of Views for a user

Groups

There are no operations or events defined for the 'Groups' entity.

Impact

The following operations are defined for the 'Impact' entity.

Operation	Description
get	This flowcode is responsbile for returning the applicable Impact(s)

Imports

There are no operations or events defined for the 'Imports' entity.

ImportsHistory

There are no operations or events defined for the 'ImportsHistory' entity.

Incidents

The following operations are defined for the 'Incidents' entity.

Operation	Description
logIncident	This flowcode operation logs an Incident using the provided parameters. Firstly it calls the component flowcode operation logRequest to actually log the incident before updating the record with any extended table details. Finally it spawns a bpm process if a service id has been provided.
selfserviceLogIncident	This flowcode operation logs an Incident using the provided parameters. Firstly it calls the component flowcode operation logRequest to actually log the incident before updating the record with any extended table details. Finally it spawns a bpm process if a service id has been provided.
update	This flowcode update a request attachment

KnownErrors

The following operations are defined for the 'KnownErrors' entity.

Operation	Description
logKnownError	This flowcode operation logs a Known Error using the provided parameters. Firstly it calls the component flowcode operation logRequest to log the incident before updating the record with any extended table details. Finally it spawns a bpm process if a service id has been provided.

Location

There are no operations or events defined for the 'Location' entity.

MessageClientTemplate

The following operations are defined for the 'MessageClientTemplate' entity.

Operation	Description
add	Add Template
delete	Delete a template includding shared records
get	Returns a template based on an ID
update	Update Template

MessageClientTemplateShare

The following operations are defined for the 'MessageClientTemplateShare' entity.

Operation	Description
add	Add Shares to the template
addOrUpdate	Adds or Updates a sharing to a template. This asumes the sharing is one only for each template. Will replace if exists and if is "personal" it will remove the sharing record

OrganizationContacts

There are no operations or events defined for the 'OrganizationContacts' entity.

Organizations

The following operations are defined for the 'Organizations' entity.

Operation	Description
add	For internal use only - Add Organisation
addToTimeline	Add to Org Timeline
archive	For internal use only - Archive an Organisation. If it has an activity stream, will post to the timeline.
get	For internal use only - Get Organisation by ID
getList	For internal use only - Get filtered and paged list of organisations
unArchive	For internal use only - UnArchive an Organisation. If it has an activity stream, will post to the timeline.
update	For internal use only - Update Organisation by ID

Pages

The following operations are defined for the 'Pages' entity.

Operation	Description
add	- PROTOTYPE - Adds a Page - the page will be added as draft
addUserType	- PROTOTYPE - Adds a new user type version to a Page - the page will be added as draft
delete	- PROTOTYPE - Retires a Page - Refers to a piblic page. It also removes draft version of the page
get	- PROTOTYPE - Returns Page details. Even if page does not exist, it will still return canEdit based on the slug and user context
managerGetList	- PROTOTYPE - Returns Page details. Even if page does not exist, it will still return canEdit based on the slug and user context
publish	- PROTOTYPE - Publishes a draft Page to be Public
retire	- PROTOTYPE - Retires a Page - Refers to a piblic page. It also removes draft version of the page
retireUserType	- PROTOTYPE - Retires a page based on a user type. Sets public to retire state (2) and deleted other states (draft and retire).
revert	- PROTOTYPE - Reverts the draft version of the Page. Removes the Draft Version.
rollback	- PROTOTYPE - Rolls back the draft version of the Page. Removes the Draft Version.
set	- PROTOTYPE - Inserts or Updates a Page
update	- PROTOTYPE - Updates a Page as Draft. If the draft version does not exist, it will duplicate the Public one

PageVersionLangs

There are no operations or events defined for the 'PageVersionLangs' entity.

PageVersions

There are no operations or events defined for the 'PageVersions' entity.

Priority

The following operations are defined for the 'Priority' entity.

Operation	Description
addPriority	This operation adds a new Priority record.
calculatePriorityFromMatrix	This operation is now deprecated.
core_getProgressiveCapturePriorities	Progressive Capture Priorities template FC in preparation for Progressive Capture 2 API support
deletePriority	This operation will delete a Priority record along with it's related records such as Timers.
getPriorities	This operation returns the list of priorities
smMovePriority	This flowcode operation updates the Priority order numbers of priorities in the system when they have been moved or re-ordered

PriorityTimerEvents

There are no operations or events defined for the 'PriorityTimerEvents' entity.

PriorityTimers

The following operations are defined for the 'PriorityTimers' entity.

Operation	Description
addTimer	Create a Timer associated to a priority

Problems

The following operations are defined for the 'Problems' entity.

Operation	Description
logProblem	This flowcode operation logs a Problem using the provided parameters. Firstly it calls the component flowcode operation logRequest to actually log the problem before updating the record with any extended table details. Finally it spawns a bpm process if a service id has been provided.
update	This flowcode update a request attachment

ProCapCustomQuestion

The following operations are defined for the 'ProCapCustomQuestion' entity.

Operation	Description
add_json	For internal use only - Returns the unread email counter for all shared mailboxed bellonging to the logged in user

Products

The following operations are defined for the 'Products' entity.

Operation	Description
addProduct	Create a Product
deleteProduct	Delete a Product
getProduct	This is the description text for this flowcode operation
updateProduct	Update the information for a Product

ProfileConnections

There are no operations or events defined for the 'ProfileConnections' entity.

ProfileContacts

There are no operations or events defined for the 'ProfileContacts' entity.

ProfileContactTypes

There are no operations or events defined for the 'ProfileContactTypes' entity.

Profiles

There are no operations or events defined for the 'Profiles' entity.

ProfileStatus

There are no operations or events defined for the 'ProfileStatus' entity.

ProgressiveCapture

The following operations are defined for the 'ProgressiveCapture' entity.

Operation	Description
getAssetSites	This flowcode operation gets details of all sites that are associatd to the specified asset(s) based on the search criteria provided.
getCustomerSite	This flowcode operation gets details of the specified customer's site.
getSites	This flowcode operation gets details of all sites based on the search criteria provided.
getUserCompanySites	This flowcode operation gets details of all sites for all companies for the specified user based on the search criteria provided.

PublishedRequests

The following operations are defined for the 'PublishedRequests' entity.

Operation	Description
get	This flowcode is responsible for returning all the applicable Published Requests based on the supplied service
retirePublishedRequest	This flowcode is responsible for setting the status of a Published Request to 'draft' when a request is either cancelled or closed
selfserviceGetDetails	This flowcode is responsible for returning the details of a Published Request
smSelfServiceGet	This flowcode is responsible for returning all the applicable Published Requests based on the supplied service
updatePublishedRequestWorkaround	This flowcode is responsible for updating the Published Request's workaround when the workaround is either edited or deleted

Questions

The following operations are defined for the 'Questions' entity.

Operation	Description
delete	This operation delete a question
queryExec	This flowcode return a request's connection
selfserviceQueryExec	This flowcode return a request's connection
systemQueryExec	This flowcode return a request's connection
translate	This flowcode is reponsible for translating question and answers in the current session language
updateAnswer	This operation update the answer to a question given by a user through the progressive capture

RelatedContainer

There are no operations or events defined for the 'RelatedContainer' entity.

RelatedRequests

There are no operations or events defined for the 'RelatedRequests' entity.

RelationshipEntities

The following operations are defined for the 'RelationshipEntities' entity.

Operation	Description
add	This flowcode link one entity to a number of other entities by using the relationship link passed in input
delete	This flowcode link one entity to a number of other entities by using the relationship link passed in input
deleteEntity	Delete a single entity from the table RelationshipEntities
get	This flowcode is responsible for querying and returning a list of entities (requests or services) linked to the specified entity
update	This flowcode link one entity to a number of other entities by using the relationship link passed in input
updateRecord	This flowcode link one entity to a number of other entities by using the relationship link passed in input
updateTimeline	This flowcode update an entity timeline. At the moment only Requests and Asset are supported.

RelationshipLinks

The following operations are defined for the 'RelationshipLinks' entity.

Operation	Description
add	This operation creates a Relationship Link. A Relationship Link consists of two Relationship Types.
delete	This operation deletes a Relationship Link, if it is not in use by one or more Relationship Entities.
deleteAll	This operation deletes one or more Relationship Link.
get	This flowcode is responsible for querying and returning a list of relationship links
update	This operation updates an existing Relationship Link.

RelationshipTypes

The following operations are defined for the 'RelationshipTypes' entity.

Operation	Description
delete	This operation deletes a Relationship Type, if it is not in use by one or more Relationship Links.
get	This flowcode is responsible for querying and returning a list of relationship types

Releases

The following operations are defined for the 'Releases' entity.

Operation	Description
logRelease	This flowcode operation logs a Release using the provided parameters. Firstly it calls the component flowcode operation logRequest to actually log the release before updating the record with any extended table details. Finally it spawns a bpm process if a service id has been provided.
schedule	Schedule a Release
unSchedule	Operation to unschedule the Release

ReportCategories

The following operations are defined for the 'ReportCategories' entity.

Operation	Description
getReportCategories	This flowcode operation gets details of all report categories.
getReportCategory	This flowcode operation gets details of the specified report category along with details of all reports that match the search criteria within that category.

ReportFavourites

The following operations are defined for the 'ReportFavourites' entity.

Operation	Description
favouriteReport	This flowcode operation favourites the specified report for the user invoking the action.
getFavouriteReports	This flowcode operation gets details of the user's favourite reports, based on the search criteria provided.
unfavouriteReport	This flowcode operation unfavourites the specified report for the user invoking the action.

ReportHistory

The following operations are defined for the 'ReportHistory' entity.

Operation	Description
add	This flowcode adds a record in the history table for reports (h_sm_reports_history)
addDocumentRevision	This flowcode updates historic report run records with the correct document ID and revision
get	This flowcode is responsible for returning the reports history

ReportInstances

The following operations are defined for the 'ReportInstances' entity.

Operation	Description
addReportInstance	This operation creates a Custom Report based on a default report for a user.
deleteReportInstance	This operation deletes a Custom Report instance belonging to the logged on user.
getReportCharts	This operation returns charts data for a Report instance.
getReportInstances	This operation gets details of the user's Custom Reports.
updateReportInstance	This operation updates a Custom Report instance belonging to the logged on user.

Reports

The following operations are defined for the 'Reports' entity.

Operation	Description
getRecentReports	This flowcode operation gets details of the most recently run reports, based on the search criteria provided.
getReport	This flowcode operation gets details of the specified report.

ReportSchedule

The following operations are defined for the 'ReportSchedule' entity.

Operation	Description
create	Create a schedule for the report to be run
delete	Removes the scheduled job, report configuration, and sm schedule info
getSchedule	This returns the schedule information for the report/instance for the user
run	Run the scheduled flowcode, and save PDF in DM if required, and send PDF via email if allowed
update	Update the scheduled job

RequestApprovers

The following operations are defined for the 'RequestApprovers' entity.

Operation	Description
update	This operation can be used to update a Request's Approvers record. This includes removing, adding or confirming an Authorisers List.

RequestAssessments

The following operations are defined for the 'RequestAssessments' entity.

Operation	Description
create	This operation creates an empty request assessment (e.g. an impact assessment) record ready for completion
get	This flowcode load the assessment for a request
systemCreate	FOR INTERNAL USE ONLY: This operation should not be invoked directly. Please use "create" operation in "RequestAssessments" entity instead.
systemUpdate	FOR INTERNAL USE ONLY: This operation should not be invoked directly. Please use "update" operation in "RequestAssessments" entity instead.
update	This operation updates a request assessment (e.g. an impact assessment) record with the answers and outcome of the assessment

RequestAttachments

The following operations are defined for the 'RequestAttachments' entity.

Operation	Description
add	Takes a JSON string of attachments that already exist on the server and apply these to a request
delete	This flowcode delete a request attachment
read	This operation returns request attachment data for a specific request
update	This flowcode update a request attachment

RequestBPMEvt

The following operations are defined for the 'RequestBPMEvt' entity.

Operation	Description
addEvent	This operation creates a BPM event for a Request.

RequestConnections

The following operations are defined for the 'RequestConnections' entity.

Operation	Description
addConnections	This operation add one or more Connections to a Request.
queryExec	This flowcode return a request's connection
removeConnection	This operation removes a Connection from a Request.
systemUpdateRequestConnection	This operation updates the connection type between a user and a request (impacted, interested, etc)
updateRequestConnection	This operation updates a Request's connection.

RequestFeedback

The following operations are defined for the 'RequestFeedback' entity.

Operation	Description
addFeedbackTimer	This operation creates a feedback timer for a Request. If a feedback timer for the Request already exists, the Id is returned.
deleteFeedbackTimer	This flowcode for delete feedback timer
queryExec	This flowcode return a request's connection
selfserviceAddFeedbackTimer	This operation creates a feedback timer for a Request. If a feedback timer for the Request already exists, the Id is returned.
selfserviceDeleteFeedbackTimer	This flowcode for delete feedback timer
systemAddFeedbackTimer	FOR INTERNAL USE ONLY: This operation should not be invoked directly. Please use "addFeedbackTimer" operation in "RequestFeedback" entity instead.
systemDeleteFeedbackTimer	FOR INTERNAL USE ONLY: This operation should not be invoked directly. Please use "deleteFeedbackTimer" operation in "RequestFeedback" entity instead.
timerEventFeedbackExpired	This flowcode used for global timer event (OnTimerEvent)

RequestHistoricEmail

There are no operations or events defined for the 'RequestHistoricEmail' entity.

RequestHistoricUpdateAttachments

The following operations are defined for the 'RequestHistoricUpdateAttachments' entity.

Operation	Description
getHistoricAttachmentsList	This operation returns a list of attachments associated to a historic request update entry

RequestHistoricUpdates

The following operations are defined for the 'RequestHistoricUpdates' entity.

Operation	Description
read	This operation returns the Historic Updates records for a Request.

RequestLastActivity

There are no operations or events defined for the 'RequestLastActivity' entity.

RequestMembers

The following operations are defined for the 'RequestMembers' entity.

Operation	Description
addRequestMember	This operation associates one or more members to a Request.
removeRequestMember	This operation removes one or more members from a Request.

Requests

The following operations are defined for the 'Requests' entity.

Operation	Description
BPMEventProcess	This operation processes a BPM event, which signals the closing of a request.
SLMEventProcess	This flowcode is called from a request timer escalation event to determine which escalation actions need to be performed (email/assignment/priority increase etc) and call the appropriate flowcodes to perform each of those actions
SLMEventProcessAssign	Called from the SLMEventProcess flowcode, this flowcode will assign a request to the specified group and/or analyst and return the assignment description which can be used for timeline entries
SLMEventProcessBMBoard	Called from the SLMEventProcess flowcode, this flowcode will assign a request to the specified group and/or analyst and return the assignment description which can be used for timeline entries
SLMEventProcessBoard	This operation is now deprecated.
SLMEventProcessEmail	Called from the SLMEventProcess flowcode, this flowcode will email notification of the request escalation to the appropriate request owner/manager and return a description of those emailed which can be used for timeline entries
SLMEventProcessNotification	This operation sends notifications when the Service Level escalation event is triggered.
SLMEventProcessPriority	This flowcode handles the increase of request priority as called from priority events
addIndexDocument	This flowcode will create a new index document in either the HornbillITSMHistoric or HornbillITSMTimeline index
addQuestions	This operation has been deprecated - This operation allows you to add questations
addRequestFeedback	This operation adds a customer's feedback to a Request.
allowTaskCompletion	This operation determines if a User is allowed to action on a Task. This will be used by 'OnAllowTaskActionOverride' Entity system event.
applyEmail	This flowcode operation applies an email's contents to a request's timeline. If content is supplied, that is used. If only the emailId is supplied, then there will be a lookup to get the email's contents, including any email attachments.
assign	This operation assigns a Request to a team or a team member.
attachFileFromServer	This attaches a file from the server to a request
attachFileFromSession	This operation attaches a file from the WebDAV session folder to a Request. This operation is only called after a file has been uploaded to WebDAV.
attachFilesFromServer	This attaches a file from the server to a request
attachFilesFromSession	Attach a file from the current session
canAccessRequest	This operation checks if the logged-on user is allowed to access a Request.
canAccessRequestPortal	This operation checks if the logged-on user is allowed to access a Request.
cancelRequest	This operation cancels a Request.
changeCustomer	This operation updates the Customer section against a request.
closeRequest	This operation updates the status of a Request to closed.
core_logProgressiveCapture	This flowcode is responsible for processing the progressive capture payload and raising a request
createCallBack	This operation is now deprecated. Please use "updateReqTimeline" operation to post the notes about a phone call into the Timeline and "tasks::taskCreate2" API to schedule a call back.
emailRequestResolution	This operation sends an email to the customer of a Request, containing the resolution details of a Request. It uses the template that is configured in app.email.template.request.resolutionDetails Application Setting.
entityAttachGetInfo	This operation returns details for a Request's attachment. This name of this operation along with the Input Params and Output Params correspond to what Core's attachment.php script excepts from an application to return attachment details.
entityGetActivityStreamAccessToken	This operation is used to allow access to a Service Manager Activity Stream. This operation is a wrapper operation for data::entityGetActivityStreamAccessToken API.
escalateRequest	This operation escalates a Request with a new Priority.
generateEmailTimelineString	Generates a timeline-friendly string when emails are sent or received.
getActivityStreamAccessToken	This operation returns the details of a Request. This includes a count of data for each expandable section within a Request.
getCustomerRequests	This flowcode is responsible for returning the customer's requests
getLinkedRequestsForAction	This operation returns linked Requests against a Request, categorised by those that can be resolved or closed.
getLinkedRequestsForClosure	This operation is now deprecated. Please use "Requests::getLinkedRequestsForAction" operation instead.
getLinkedRequestsForResolution	This operation is now deprecated. Please use "Requests::getLinkedRequestsForAction" operation instead.
getOwnershipDetails	This flowcode return a request's connection
getQuickSearchRequestId	This operation return the ID of a request, when only its numeric part is provided. The input param (requestId) can be a full request ID (e.g. CH00011709) or only its numeric part (e.g. 11709). If a complete value is provided (e.g. requestId = CH00011709), then the operation return the same value ((e.g. fullRequestId = CH00011709). If only the numeric part is provided then the operation will return the first request ID matching the numeric value, prefixed with 0s or characters. For example, if requestId = 11709 then the operation can return CH00011709 but not CH00211709 (because 11709 can only be prefixed by zeros and characters). If no request is found, then the operation will return undefined.
getRequestRecord	This operation returns the details of a Request and , optionally, the related entities
getVisibilityLevel	This operation returns the logged-on person's visibility to a Request.
guestAttachFile	Allow a trusted guest to attach a file to a request. DEPRECATED - Use selfserviceAttachFileFromSession instead.
guestAttachFileFromSession	This flowcode operation attaches a file to a request from a guest session. DEPRECATED - Use selfserviceAttachFileFromSession instead.
guestCanViewRequest	DEPRECATED - use selfserviceCheckRequestVisibleToUser instead. This flowcode operation determines a guest's rights to view and edit a request.
guestGetConnectedRequests	This flowcode load the requests the user is connected to, in the Customer Portal
guestGetFeedbackTimer	This flowcode return a request's connection
guestGetFileAttachmentInfo	This operation is now deprecated. Please use "selfserviceGetAttachmentInfo" operation instead.
guestGetRequests	This flowcode load the requests visible in the Customer Portal
guestGetTimelineAccessToken	This flowcode operation gets the request access token for the specified request.
guestLogRequest	DEPRECATED - use selfserviceLogRequest instead. This Flowcode logs a Request on behalf of a guest contact using the provided parameters. It updates the Request Timeline and spawns a BPM Process if a Service ID is provided.
holdRequest	This flowcode places a request On Hold and pause any Timers that are associated.
holdRequestTimer	Pause the Request timer(s)
isLinkedToEntity	This flowcode returns the link status for a list of requests. For example, if we want to know which one of the following requests are linked to the request IN0000123 then we need to pass entityId=IN0000123, entityName=Requests, requestId=[IN00002345,IN0003885, ...]
linkRequests	This operation is now deprecated. Please use "add" operation in "RelationshipEntities" Entity instead.
logRequest	This operation creates a new Request using the supplied information.
logRequestBPM	This operation spawns a business process for the supplied Request.
lookupCustomerEmail	This operation is now deprecated. Please use "userProfileGet" mathod in "session" service instead.
markFix	Mark the Resolution/Fix timer
markResponse	Mark the response timer
markTimerMissed	This marks a request as having missed its timer
onTimelineUpdate	This operation is called when a new update or comment is posted to a Request's Timeline. This operation adds a document for the update to the HornbillITSMTimeline index.
onTimelineUpdateNotification	This operation sends an email notification to a Request's customer on Timeline update.
rejectFeedback	This updates the request removing the feedback
removeAttachments	This flowcode deletes attachments from a specified request.
removeTimers	This flowcode script will remove the timers - including system timers - associated with a request
reopenRequest	This flowcode will attempt to reopen the request, checking whether it is currently resolved/closed first, increasing the reopen count and updating the request
requestCustomerDetails	This operation returns details for a Request's Customer.
resolveLinkedRequest	This operation provides configurable options to resolve Linked Requests in a Request.
resolveRequest	This operation resolves a Request.
searchHistoricUpdates	This flowcode operation searches request historic updates for the lucene search query provided.
searchRequests	This flowcode operation searches requests for the search query provided.
searchTimeline	This flowcode operation searches request historic updates for the lucene search query provided.
selfserviceAttachFileFromSession	This flowcode operation attaches a file to a request.
selfserviceCancelRequest	This operation updates the status of a Service Request to Cancelled for a selfservice user, and cancels any associated workflow and activities.
selfserviceCheckRequestVisibleToUser	This operation determines whether a Portal user is allowed to access a Request.
selfserviceCloseRequest	This operation updates the status of a Request to closed for a selfservice user.
selfserviceCountRequests	This flowcode load the requests visible in the Service Portal
selfserviceGetAssetsList	This flowcode returns asset information for use in the portals progressive capture asset form
selfserviceGetAttachmentInfo	This operation provides you with information on a file attachment that is associated to a Request. This operation is only for the Portals.
selfserviceGetConnectedRequests	This flowcode load the requests the user is connected to, in the Service Portal
selfserviceGetRequests	This flowcode load the requests visible in the Service Portal
selfserviceGetTimelineAccessToken	This flowcode operation gets the request access token for the specified request.
selfserviceLogRequest	This flowcode operation logs a request using the provided parameters. Firstly it calls the component flowcode operation logRequest to actually log the incident before updating the record with any extended table details. Finally it spawns a bpm process if a service id has been provided.
selfserviceMarkUnread	This operation marks a Request as unread for Self Service users.
selfserviceReopenRequest	This flowcode will attempt to reopen the request, checking whether it is currently resolved/closed first, increasing the reopen count and updating the request
selfserviceRequestLastModified	This flowcode is responsible for updating the last modified date for a specific request
selfserviceSmGetAssetTypes	This flowcode operation gets the linked asset types for a specified request.
selfserviceSmGetAssets	This flowcode operation gets the linked attachments for a specified request.
selfserviceSmGetAttachments	This flowcode operation gets the linked attachments for a specified request.
selfserviceSmGetDetails	This flowcode operation gets the request details and all related request details for a specified request.
selfserviceSmGetReqDetails	This flowcode operation gets the request details and all related request details for a specified request.
selfserviceSmResumeBPM	This operation is capable of resuming the BPM of a Request, with the option to resume linked Requests.
selfserviceSmUpdateStatus	This flowcode is used to update the request status from a customer update
selfserviceUpdateTimeline	Posts to the activity stream
sendMessage	This is a defunct email flowcode - smSendMessage should be used.
setupRequestStageExpiry	This operation prepares the expiry of a BPM stage for a given period of time.
smEventTypeNotifiers	This operation returns the notifiers for a Request based on the supplied event type.
smGetAssetTypes	This flowcode operation gets the linked asset types for a specified request.
smGetAssets	This operation returns the Assets that are associated to the supplied Request.
smGetAttachments	This operation returns the attachments for a Request.
smGetDetails	This operation is now deprecated. Please use "Requests::fc_ops::smGetReqDetails2" instead.
smGetFullActivityStream	This flowcode operation gets the activity stream for a specified request.
smGetLinkedReq	This flowcode operation gets the linked request details for a specified request.
smGetReqBoards	This operation is now deprecated.
smGetReqDetails	This operation is now deprecated. Please use "smGetReqDetails" operation intead.
smGetReqDetails2	This operation returns the details of a Request. This includes a count of data for each expandable section within a Request.
smGetReqEntitiesOwners	This operation returns the owners of a Request's entities. These entities include Request's Service owner, Linked Services owners and Linked Assets Owners where available.
smGetRequests	This operation returns filtered Requests based on the supplied conditions. Only the Requests that the logged-on user is allowed to access will be returned.
smGetSites	Retrieves a filtered list of sites
smGetTeamsUserSupportsRequestWith	Return a list of teams that the user is a member of, that are supporting a Request.
smNotification	This operation sends Hornbill and/or email notification for Service Manager features.
smNotificationAssignment	This operation has now been deprecated.
smNotificationAssignmentTeam	This operation has now been deprecated.
smNotificationAutoresponder	This operation has now been deprecated.
smNotificationAutoresponderTeam	This operation has now been deprecated.
smNotificationCancel	This operation has now been deprecated.
smNotificationCancelTeam	This operation has now been deprecated.
smNotificationCustomerPortalUpdate	This operation has now been deprecated.
smNotificationCustomerPortalUpdateTeam	This operation has now been deprecated.
smNotificationFeedbackSubmitted	This operation has now been deprecated.
smNotificationLinkedReqResolveAction	This operation has now been deprecated.
smNotificationLinkedReqResolveActionTeam	This operation has now been deprecated.
smNotificationMembersAdded	This operation has now been deprecated.
smNotificationMembersAddedRecipient	This operation has now been deprecated.
smNotificationMembersAddedTeam	This operation has now been deprecated.
smNotificationSendEmail	This operation sends an email notification to specified recipient(s).
smNotificationSendEmailDirect	This operation is now deprecated. Please use "Requests::smNotificationSendEmailDirect2" operation instead.
smNotificationSendEmailDirect2	This operation sends an email notification to the supplied recipient(s) using the direct message option.
smNotificationSubStatusUpdate	This operation has now been deprecated.
smNotificationSubStatusUpdateTeam	This operation has now been deprecated.
smNotificationV2	This operation sends Hornbill and/or email notification for Service Manager features.
smNotifyEmailCustomer	This flowcode operation sends an email to the customer of a request. It allows you to define the mailbox that the email will be sent from as well as the email template that will be used.
smNotifyTaskAuthoriser	This flowcode operation sends an email notification to a task authoriser
smPortalGetServices	This operation returns a Service's details.
smResumeBPM	This operation is capable of resuming the BPM of a Request, with the option to resume linked Requests.
smSLMEscalateEmailCustomer	Send the request resolution by email
smSLMEscalateResolutionTimer	This will escalate the resolution timer of a request to the new service levels timer
smSLMEscalateResponseTimer	This will escalate the response timer of a request to the new service levels timer
smSLMEscalateServiceLevel	This is used to amend the service level for a request
smSLMGetServiceLevel	This flowcode processes configured SLM rules for a service and returns the id of the relevant service level to apply to the request
smSLMGetServiceLevelAgreement	This flowcode processes configured SLM rules for a service and returns the id of the relevant service level agreement to apply to the request
smSLMGetServiceLevelProcessCondition	This flowcode processes the Rule Conditions configured against the chosen service using the data within the request
smSLMGetServiceLevelProcessValue	This flowcode processes the value of a Rule Condition configured against the chosen service using the data within the request
smSLMProcessSLChange	This flowcode is called from a global timer event to process and complete a service level change on a request
smSLMSetServiceLevel	Sets the Service Level for a request
smSLMStartResolutionTimer	This flowcode creates service based service level resolution timers and escalation events for a given request
smSLMStartResponseTimer	This flowcode creates service based service level response timers and escalation events for a given request
smSendMessage	This operation sends an email from within a Request.
smSendSystemNotification	This operation is now deprecated. Please use "event::postMessage" API instead.
smUpdateReqTimeline	This operation is now deprecated. Please use "updateReqTimeline" operation instead.
smUpdateStatus	This flowcode is used to update the Status of a request and optionally update the Sub-status. You can choose whether to update the timeline, set the visibility of the timeline post and choose to set an indefinite or fixed off-hold time if updating the request status to 'On Hold'
smUpdateSubstatus	This flowcode validates and updates a request sub-status
systemAssign	FOR INTERNAL USE ONLY: This operation should not be invoked directly. Please use "assign" operation in "Requests" entity instead.
systemAttachFileFromServer	FOR INTERNAL USE ONLY: This operation should not be invoked directly. Please use "attachFileFromServer" operation in "Requests" entity instead.
systemAttachFileFromSession	FOR INTERNAL USE ONLY: This operation should not be invoked directly. Please use "attachFileFromSession" operation in "Requests" entity instead.
systemAttachFilesFromServer	FOR INTERNAL USE ONLY: This operation should not be invoked directly. Please use "attachFilesFromServer" operation in "Requests" entity instead.
systemAttachFilesFromSession	FOR INTERNAL USE ONLY: This operation should not be invoked directly. Please use "attachFilesFromSession" operation in "Requests" entity instead.
systemCancelRequest	FOR INTERNAL USE ONLY: This operation should not be invoked directly. Please use "cancelRequest" operation in "Requests" entity instead.
systemCloseRequest	FOR INTERNAL USE ONLY: This operation should not be invoked directly. Please use "closeRequest" operation in "Requests" entity instead.
systemEscalateRequest	FOR INTERNAL USE ONLY: This operation should not be invoked directly. Please use "escalateRequest" operation in "Requests" entity instead.
systemHoldRequest	FOR INTERNAL USE ONLY: This operation should not be invoked directly. Please use "holdRequest" operation in "Requests" entity instead.
systemRejectFeedback	FOR INTERNAL USE ONLY: This operation should not be invoked directly. Please use "rejectFeedback" operation in "Requests" entity instead.
systemReopenRequest	FOR INTERNAL USE ONLY: This operation should not be invoked directly. Please use "reopenRequest" operation in "Requests" entity instead.
systemResolveRequest	FOR INTERNAL USE ONLY: This operation should not be invoked directly. Please use "resolveRequest" operation in "Requests" entity instead.
systemSmResumeBPM	FOR INTERNAL USE ONLY: This operation should not be invoked directly. Please use "smResumeBPM" operation in "Requests" entity instead.
systemSmUpdateStatus	FOR INTERNAL USE ONLY: This operation should not be invoked directly. Please use "smUpdateStatus" operation in "Requests" entity instead.
systemSmUpdateSubstatus	FOR INTERNAL USE ONLY: This operation should not be invoked directly. Please use "smUpdateSubstatus" operation in "Requests" entity instead.
systemUpdate	FOR INTERNAL USE ONLY: This operation should not be invoked directly. Please use "update" operation in "Requests" entity instead.
takeFixTimerOffHold	Resume a Resolution/Fix timer
takeRequestOffHold	This flowcode takes a request off hold, can be called directly or via timer event
takeResponseTimerOffHold	Resume a Response timer
update	Update the primary and extended fields of a request
updateLinkedRequestsTimeline	This operation is used to post into the Timeline of Requests that are linked to a Request.
updateParentReqTimeline	This operation posts an update to a Parent Request's Timeline when resolving or closing Linked Requests.
updateProperties	This flowcode update the request properties
updateReqTimeline	This operation posts an update to a Request's Timeline.
updateRequest	This operation marks a Request's response time and is now deprecated. Please use "Requests::markResponse" operation instead.
updateResolutionDetails	This operation updates the resolution details of a Request.
updateTimeline	This operation is now deprecated. Please use "updateReqTimeline" operation instead.

The following events are defined for the 'Requests' entity.

Event	Description
OnAllowTaskActionOverride	Entity system event handler for OnAllowTaskActionOverride
OnGetActivityStreamAccessToken	Returns visibility for request activity stream when access token is requested.
OnRecordAdded	Entity system event handler when new record is added
OnRecordUpdated	Entity system event handler when record is updated

RequestsConfiguration

The following operations are defined for the 'RequestsConfiguration' entity.

Operation	Description
create	This operation creates a record to store the customised configuration for a Request feature.
customerSectionGet	This operation returns the customised configuration for the Customer section.
delete	This operation updates a Requests configuration record for a Request feature.
update	This operation updates a Requests configuration record for a Request feature.

RequestsExtended

There are no operations or events defined for the 'RequestsExtended' entity.

RequestSLMArchive

The following operations are defined for the 'RequestSLMArchive' entity.

Operation	Description
browse	This will return archived service level records for a request
create	Create an archive of the Service Level

RequestSLMChanges

The following events are defined for the 'RequestSLMChanges' entity.

Event	Description
OnRecordAdded	Entity system event handler when new record is added

RequestSLMEvt

The following operations are defined for the 'RequestSLMEvt' entity.

Operation	Description
addRequestEvent	This flowcode stores the details of SLM events for a given request
createRequestSLMEvents	Create SLM Events for a Request
smAddRequestEvent	This flowcode stores the details of SLM events for a given request
smCreateEscalationSLMEvents	This flowcode creates service based service level events for a request
smCreateRequestSLMEvents	This flowcode creates service based service level events for a request

RequestSLMTargets

The following operations are defined for the 'RequestSLMTargets' entity.

Operation	Description
create	Create a request service level target entry
update	Update a request service level target entry

RequestStatusHistory

The following operations are defined for the 'RequestStatusHistory' entity.

Operation	Description
addStatusHistory	This flowcode operation records details of a request assignment.

RequestTimers

The following operations are defined for the 'RequestTimers' entity.

Operation	Description
addRequestTimer	This will create a timer. If the timer already exists, it will return the ID of the existing timer
guestAddRequestTimer	Allow trusted guests to post to the timeline of a Request

ResponseTimes

There are no operations or events defined for the 'ResponseTimes' entity.

Roles

There are no operations or events defined for the 'Roles' entity.

RoutingRuleTemplates

The following operations are defined for the 'RoutingRuleTemplates' entity.

Operation	Description
addRoutingRuleTemplate	This operation creates a Routing Rule template.
deleteRoutingRuleTemplate	This operation deletes a Routing Rule template.
updateRoutingRuleTemplate	This operation updates an existing Routing Rule template.

SearchHistory

The following operations are defined for the 'SearchHistory' entity.

Operation	Description
create	Log a new entry in the search history
read	This flowcode is responsible for returning portal search history terms
update	Update the search term with the service ID

ServiceBulletin

The following operations are defined for the 'ServiceBulletin' entity.

Operation	Description
attachImage	This uploads an image for a given bulletin
deleteServiceBulletinImage	This flowcode is repsonsible for deleting the image against the specified bulletin
entityAttachGetInfo	This operation returns details for a Bulletin's attachment. This name of this operation along with the Input Params and Output Params correspond to what Core's attachment.php script excepts from an application to return attachment details.
getServiceBulletin	This flowcode is responsible for getting all the Bulletins against a particular service
reorderServiceBulletinItems	This flowcode is responsible for re-arranging the Bulletins relative to their Service
selfServiceGetServiceBulletin	This flowcode is responsible for getting all the Bulletins against a particular service

ServiceConnections

The following operations are defined for the 'ServiceConnections' entity.

Operation	Description
getServiceConnection	This flowcode update an entity ServiceConnection, used to configure if a connection can see a request raised against a service
setServiceConnection	This flowcode add a new entity ServiceConnection, used to configure if a connection can see a request raised against a service

ServiceFeedbackQuestionInputs

The following operations are defined for the 'ServiceFeedbackQuestionInputs' entity.

Operation	Description
get	This flowcode is responsible for returning the question inputs regarding a feedback question
reorderFeedbackQuestionInputs	This flowcode is responsible for re-arranging the Feedback Question Inputs according to their specified Request Type

ServiceFeedbackQuestions

The following operations are defined for the 'ServiceFeedbackQuestions' entity.

Operation	Description
getFeedbackQuestionDetails	This operation is now deprecated.
getFeedbackQuestions	Get Feedback Questions
reorderFeedbackQuestions	This flowcode is responsible for re-arranging the Feedback Questions according to their specified Request Type
smSelfServiceGetFeedbackQuestions	Get Feedback Questions

ServiceLevelAgreements

The following operations are defined for the 'ServiceLevelAgreements' entity.

Operation	Description
create	This flowcode operation creates a new service level agreement
read	Get a list of service level agreements
update	This flowcode operation updates an existing service level.

ServiceLevelAgreementService

The following operations are defined for the 'ServiceLevelAgreementService' entity.

Operation	Description
smAddServiceLevelServiceEntry	This flowcode adds 1 or more links between a service level and a service
smDeleteServiceLevelServiceEntry	This flowcode makes checks as to where a chosen service level is in use and will remove the service level from the service and make appropriate updates to rules to maintain data integrity
smReorderServiceLevels	This flowcode operation updates the service level order numbers in the system when they have been moved or re-ordered for visual purposes

ServiceLevelRules

The following operations are defined for the 'ServiceLevelRules' entity.

Operation	Description
create	This flowcode creates a service level rule
delete	This flowcode deletes a service level rule
read	This flowcode returns rules for selecting a service level
update	This flowcode updates a service level/service level agreement rule

ServiceLevels

The following operations are defined for the 'ServiceLevels' entity.

Operation	Description
getPriorityBasedServiceLevelsInUse	This flowcode is responsible for returning priority based service levels
smCreateServiceLevel	This flowcode operation creates a new service level.
smGetServiceLevelsBySLA	This operation returns a JSON string of Service Levels associated to a Service Level Agreement
smUpdateServiceLevel	This flowcode operation updates an existing service level.

ServiceLevelServiceLevelAgreement

The following operations are defined for the 'ServiceLevelServiceLevelAgreement' entity.

Operation	Description
reorder	This flowcode operation updates the service level order numbers in the system when they have been moved or re-ordered for visual purposes

ServiceLevelTargetEvents

The following operations are defined for the 'ServiceLevelTargetEvents' entity.

Operation	Description
smAddServiceLevelTargetEvent	This flowcode adds service level target events
smGetServiceLevelTargetEvents	This flowcode gets service level target events for a specific target
smUpdateServiceLevelTargetEvents	This flowcode updates service level target events

ServiceLevelTargets

The following operations are defined for the 'ServiceLevelTargets' entity.

Operation	Description
smGetServiceLevelTargets	This flowcode returns service level targets related to a specfic service level

ServiceRequestConfiguration

The following operations are defined for the 'ServiceRequestConfiguration' entity.

Operation	Description
addServiceRequestConfiguration	This flowcode add a new entity ServiceRequestConfiguration used to configure some request properties when the request is raised against a service
getServiceRequestConfiguration	This flowcode update an entity ServiceRequestConfiguration used to configure some request properties when the request is raised against a service
systemAddServiceRequestConfiguration	FOR INTERNAL USE ONLY: This operation should not be invoked directly. Please use "addServiceRequestConfiguration" operation in "ServiceRequestConfiguration" entity instead.
systemGetServiceRequestConfiguration	FOR INTERNAL USE ONLY: This operation should not be invoked directly. Please use "getServiceRequestConfiguration" operation in "ServiceRequestConfiguration" entity instead.
systemUpdateServiceRequestConfiguration	FOR INTERNAL USE ONLY: This operation should not be invoked directly. Please use "updateServiceRequestConfiguration" operation in "ServiceRequestConfiguration" entity instead.
updateServiceRequestConfiguration	This flowcode update an entity ServiceRequestConfiguration used to configure some request properties when the request is raised against a service

ServiceRequestDetails

The following operations are defined for the 'ServiceRequestDetails' entity.

Operation	Description
addServiceRequestDetails	This flowcode add a new entity ServiceRequestDetails used to configure some request properties when the request is raised against a service
getServiceRequestDetails	This flowcode update an entity ServiceRequestDetails used to configure some request properties when the request is raised against a service
systemAddServiceRequestDetails	FOR INTERNAL USE ONLY: This operation should not be invoked directly. Please use "addServiceRequestDetails" operation in "ServiceRequestDetails" entity instead.
systemGetServiceRequestDetails	FOR INTERNAL USE ONLY: This operation should not be invoked directly. Please use "getServiceRequestDetails" operation in "ServiceRequestDetails" entity instead.
systemUpdateServiceRequestDetails	FOR INTERNAL USE ONLY: This operation should not be invoked directly. Please use "updateServiceRequestDetails" operation in "ServiceRequestDetails" entity instead.
updateServiceRequestDetails	This flowcode update an entity ServiceRequestDetails used to configure some request properties when the request is raised against a service
updateServiceRequestForm	This flowcode is reponsible for creating / updating the Service Request Details Form record

ServiceRequests

The following operations are defined for the 'ServiceRequests' entity.

Operation	Description
logServiceRequest	This flowcode operation logs a Service Request using the provided parameters. Firstly it calls the component flowcode operation logRequest to actually log the service request before updating the record with any extended table details. Finally it spawns a bpm process if a service id has been provided.
selfserviceLogServiceRequest	This flowcode operation logs a Service Request using the provided parameters. Firstly it calls the component flowcode operation logRequest to actually log the service request before updating the record with any extended table details. Finally it spawns a bpm process if a service id has been provided.

Services

The following operations are defined for the 'Services' entity.

Operation	Description
canAccessServices	This operation checks if the logged-on user is allowed to access a Service, inline with the subscription model. Where a Service Id is not supplied, all the Services that the user is allowed to access will be returned.
core_getProgressiveCaptureServices	Experimetal template FC in preparation for Progressive Capture 2 API support
core_init_getProgressiveCaptureServices	Experimetal template FC in preparation for Progressive Capture 2 API support
deleteService	This operation is now deprecated. Please use "smOnServiceDelete" operation in Services Entity and "translateDelete" global operation instead.
getBpmList	This operation is deprecated. Please use 'bpm::workflowUserGetList' API instead. Documentation can be found here: https://api.hornbill.com/bpm/?op=workflowUserGetList
getServiceRecord	This operation returns the details of a Service and , optionally, the related entities
getSupportTeamServices	This operations provides a list of Services that a Customer is subscribed to and the User's Team(s) supports.
selfserviceGetServices	This flowcode is responsible for returning all the Services to the Portals, Self Service landing page and Catalog component. The services returned are dependant on the session user. It will return the results categorised by "All", "Favourites" "Active", "Impacted" and the respective Service Categories
selfserviceGetServicesByUser	This operation returns Services that are visible to the logged-on person in Self Service. This operation provides various filtering options and control over the type of data that is returned.
selfserviceServiceDetails	This operation is intended for Self Service and serves the purpose to return information about Services that a user is allowed to access. You also have the option to return information about a specific Service.
smAddSupportTeam	This operation associates a supporting team to a Service.
smCreateService	This operation is now deprecated.
smCreateService2	This operation is now deprecated.
smDropSupportTeam	This operation removes a supporting team from a Service.
smGetCustomerByServiceSubscription	This flowcode is responsible for querying and returning a list of all the applicable subscribers against a service based on the input query
smGetPCServices	This flowcode is responsible for querying and returning a list of all the applicable subscribers against a service based on the input query
smGetServiceDetails	This operation returns the list of Services and details of each Service that the logged-on person has access to.
smGetServicesByUser	This flowcode is responsible for returning Services for the User (getServicesByUser) or Supported by the User (getServicesSupportedByUser)
smGetServicesSubscribedBySite	This operation is responsbile for returning a list of Service(s) which have the supplied Site associated to them
smGetSubscribers	This operation returns the subscribers of a Service.
smOnServiceCreate	This operation creates the related records to a Service record.
smOnServiceDelete	This operation deletes the related records to a Service record.
smSelfServiceGetService	"This operation is deprecated. Please use Services::selfserviceGetServices API instead. Documentation can be found here: https://api.hornbill.com/apps/com.hornbill.servicemanager/Services?op=selfserviceGetServices"
smSetStatus	This operation updates a Service's status.
smUpdateServicePortalVisibility	This operation updates the Service Portal Visibility property against a Service.
smUpdateServiceRequestTypeVisibility	This operation updates the visibility (i.e. hide or show) of a Service by Request type.
update	This operation updates the properties in a Service.

ServiceStatus

The following events are defined for the 'ServiceStatus' entity.

Event	Description
OnRecordAdded	Entity system event handler when new record is added

ServiceStatusHistory

The following operations are defined for the 'ServiceStatusHistory' entity.

Operation	Description
add	This flowcode is used to add entities ServiceStatusHistory
get	This flowcode load the history of a service's status
systemAdd	This flowcode is used to add entities ServiceStatusHistory
update	This flowcode is used to update entities ServiceStatusHistory

ServiceSubscriptions

The following operations are defined for the 'ServiceSubscriptions' entity.

Operation	Description
add	This operation allows a Service user to add a subscriber to a Service.
remove	This operation allows a Service user to remove a subscriber from a Service.
update	This operation allows a Service user to update a subscription.

ServicesUsers

The following operations are defined for the 'ServicesUsers' entity.

Operation	Description
Create	Create an entity ServicesUsers
Delete	This operation is now deprecated. Please use "ServiceUsers::DeleteByRelType" operation instead.
DeleteByRelType	This flowcode delete the users associated to the service based on relType. For example, we want to delete the service owner or the service delegates
Update	This operation is now deprecated. Please use "ServiceUsers::UpdateUsers" operation instead.
UpdateUsers	This flowcode update the service users (which can be owners or delegates) . It remove the old ones and add the new ones. The new users are passed as list of "user" in the input params, where each user is a json object with properties id and name
getUsersByService	Load owner and delegate for a service. We assume that there is max 1 owner and 1 delegate per service, no multiple owners or multiple delegates

ServiceTeams

The following operations are defined for the 'ServiceTeams' entity.

Operation	Description
get	This operation returns the assignable supporting teams in a Service. When a Service is not supplied, the assignable teams in the system are returned.
getUserServiceTeams	This flowcode operation gets a list of teams that support the services that the user is subscribed to.

SharedViews

The following operations are defined for the 'SharedViews' entity.

Operation	Description
adminGetSharedViews	This operation returns the shared Views in the system.
delete	This operation removes a Shared View record.
getSharedViews	This Flowcode is used to get Shared Views for a particular Custom Filter.
getSharedViewsByUser	This flowcode is responsible for returning all of the shared views against the session User, Teams or Services

SiSInventoryComputer

There are no operations or events defined for the 'SiSInventoryComputer' entity.

SiSInventoryComputerSoftware

There are no operations or events defined for the 'SiSInventoryComputerSoftware' entity.

SiSInventoryList

There are no operations or events defined for the 'SiSInventoryList' entity.

SiSInventoryListComputer

There are no operations or events defined for the 'SiSInventoryListComputer' entity.

SiSJob

There are no operations or events defined for the 'SiSJob' entity.

SiSPackage

The following operations are defined for the 'SiSPackage' entity.

Operation	Description
baselinePackage	baseline a package

SiSPublishedPackage

The following operations are defined for the 'SiSPublishedPackage' entity.

Operation	Description
revertBaselinePackage	take a baselined package and revert it to draft

Site

The following operations are defined for the 'Site' entity.

Operation	Description
getNearby	This operation is responsible for returning the nearby Sites of a specificed Site by its ID
getSiteById	This operation is responsible for returning the Site Details of a specificed Site by its ID
getSiteUsers	This operation is responsible for returning the Site Users of a specificed Site by its ID
getSites	This operation is responsible for returning the either a number of, or all the Sites available, with option of filtering down the results
update	This operation is responsible for updating the Custom fields of a specified Site

SiteMembers

The following operations are defined for the 'SiteMembers' entity.

Operation	Description
add	This operation is responsible for adding a member to a specificed Site by its ID
delete	This operation is responsible for removing a user as a Site Member against a Site
get	This operation is responsible for returning the Site Members of a specificed Site by its ID

SLC

There are no operations or events defined for the 'SLC' entity.

Snippet

The following operations are defined for the 'Snippet' entity.

Operation	Description
addSnippet	Create a Snippet
changeOwner	This operation changes the owner of the supplied Snippet(s).
deleteSnippet	This operation archives a Snippet.
get	This flowcode is reponsible for returning the user's snippets as well as their service or teams
getList	This flowcode is responsible for querying and returning a list of all the available snippets based on the input query
updateSnippet	Update a Snippet

SnippetShare

There are no operations or events defined for the 'SnippetShare' entity.

Statuses

The following operations are defined for the 'Statuses' entity.

Operation	Description
read	This flowcode returns sub-status levels which can be filtered by language, service, request type and parent status

Task

The following operations are defined for the 'Task' entity.

Operation	Description
AttachFile	For internal use only - Attach a file to the task entity
deleteTask	For internal use only - Delete a task
entityAttachGetInfo	Get access to file attachments for this entity
getAttachments	View the attachments for a Task
getEntityTasks	Return tasks assigned to specific entity
getNewTasks	For internal use only - Load tasks from notifications
removeFile	For internal use only - Remove an attached file

Task_categories

There are no operations or events defined for the 'Task_categories' entity.

Task_notes

There are no operations or events defined for the 'Task_notes' entity.

TaskBoard

The following operations are defined for the 'TaskBoard' entity.

Operation	Description
addBoard	For internal use only - Create new board
addDefaultBoard	For internal use only - Adding default board and defining task lists
getBoard	For internal use only - Read board data
getBoardTasks	For internal use only - Flowcode return specified board lists with tasks
queryBoards	For internal use only - return boards belonging to user (query is taking user from session)
updateBoard	For internal use only - Update board data

TaskBoardList

The following operations are defined for the 'TaskBoardList' entity.

Operation	Description
addBoardList	For internal use only - adding new list to board
deleteBoardList	For internal use only - Delete specified list
filterBoardListTasks	For internal use only - return filtered tasks, for more secure searching (only tasks that user can see) to filtered data are added from session user id and roles
filterTasks	For internal use only - return filtered tasks, will filter from list one by one and return results in same order
getBoardList	For internal use only - Return single list row
getBoardListTasks	For internal use only - Return list tasks that are assigned manually
getListTasks	For internal use only - Loading tasks one by one for all specified input id, checking every list for type (filter or manual) and calling specific query depends on it. At end return json stringified array of lists with tasks.
queryBoardLists	For internal use only - return lists belonging to user
updateBoardList	For internal use only - Updating board list record
updateListPositions	For internal use only - Updating lists position in order of appear in array

TaskBoardListTask

There are no operations or events defined for the 'TaskBoardListTask' entity.

TaskTemplate

The following operations are defined for the 'TaskTemplate' entity.

Operation	Description
add	For internal use only - Create new board
get	For internal use only - Create new board
remove	For internal use only - Create new board
update	For internal use only - Create new board

Team

The following operations are defined for the 'Team' entity.

Operation	Description
core_getProgressiveCaptureTeams	This loads the teams for progressive capture 2
get	This flowcode is responsbile for returning Teams

TeamAssignment

There are no operations or events defined for the 'TeamAssignment' entity.

TeamMemberAssignment

The following operations are defined for the 'TeamMemberAssignment' entity.

Operation	Description
core_getProgressiveCaptureAnalysts	This returns the analysts available for assignment for a given team
core_init_getProgressiveCaptureAnalystAssignment	This returns the settings for the analysts assignment
insertUpdate	This flowcode is responsible for inserting and updating request assignment restrictions for team members
toggleAll	This flowcode is responsible for updating all of the request assignment restrictions for team members

TeamUsers

There are no operations or events defined for the 'TeamUsers' entity.

Templates

There are no operations or events defined for the 'Templates' entity.

Timers

There are no operations or events defined for the 'Timers' entity.

UserAccount

The following operations are defined for the 'UserAccount' entity.

Operation	Description
getTeams	Flowcode Operation using the supplied Customer User Id to retrieve the user's Container Id and Customer Name

UserEntityList

There are no operations or events defined for the 'UserEntityList' entity.

UserServiceFavourites

The following operations are defined for the 'UserServiceFavourites' entity.

Operation	Description
smPortalsAddFavourite	This flowcode is responsible for adding a particular Service as the currently logged in User's favourite
smPortalsDeleteFavourite	This flowcode is responsible for deleting a particular Service as the currently logged in User's favourite
smPortalsGetFavourites	This flowcode is responsible for getting all the Favourite Services related to the currently logged in User

Vendors

The following operations are defined for the 'Vendors' entity.

Operation	Description
addVendor	Create a Vendor
deleteVendor	Delete a Vendor
getVendor	This is the description text for this flowcode operation
updateVendor	Update information for a Vendor

Versions

The following operations are defined for the 'Versions' entity.

Operation	Description
addVersion	Create a Version
deleteVersion	Delete a Version
updateVersion	Update information for a Version

Operations

The following general operations are defined for the 'com.hornbill.servicemanager' application. You can click on each operation to see detailed information about that operation.

Method	Source	Description
ServiceManagerOutlook	local	NOT FOR PRODUCTION USE This API is intended to be used on the Hornbill instance only.
addEveryoneToRole	global	For internal use only - Add all users to the specified role
addEveryoneToWorkspace	global	For internal use only - Add all users to the specified workspace
addHistory	global	For internal use only - Add a historic bookmark for the page visited
addMembersToWorkspace	global	For internal use only - Add users, groups or members to a specified workspace
adminAssignUsersToGroupbyGroupAndRole	global	assign users to group by group and or role
adminAssignUsersToRolebyGroupAndRole	global	assign users to a role by group and or other role
adminBpmAddTemplate	global	add a bpm template
adminBpmDeleteTemplate	global	delete a template
adminBpmFindProcessesByPropertyText	global	add a bpm template
adminBpmGetLiveInstance	global	Get live instance record
adminBpmGetTemplate	global	get bpm template record
adminBpmGetTemplatesForList	global	get bpm templates for app returing just id, name, type and grouping
adminBpmGetTemplatesTable	global	Get BPM templates for a given app
adminBpmUpdateLiveInstance	global	Update live instance record
adminDatabaseListCreateRecord	global	create record in h_sys_dblists
adminDatabaseListDeleteRecord	global	deleterecord in h_sys_dblists
adminDatabaseListGetListValues	global	Get db list and then get list values for it
adminDatabaseListUpdateRecord	global	create record in h_sys_dblists
adminGetSetting	global	For internal use only - Used to read system settings for views that dont need manage sys settings role
adminInitaliseData	global	Used by the Admin App to get all the initial data need on first lost.
adminInitialiseData	global	Used by the Admin App to get all the initial data need on first lost.
adminTermsAndConditionsSet	global	For internal use only - Used to get email list (Paged) and count of emails
appCoreInitaliseData	local	This loads application data to be used in the setup of the application
appCoreInitialiseData	local	This operation returns the initialise data for the application.
appHomeInitialiseData	local	This flowcode is responsible for getting all the relative Service Bulletins for a user, against all their subscribed services (Users) and populating the Hornbill Home View slides
applicationCacheClear	local	SYSTEM USE ONLY. This operation clears application specific cached information.
applicationSyncDb	local	This operation is used to wait for the database to synchronise. This operation should only be used when the next action relies on a record that was added, updated or deleted in a previous action.
arRaiseNewRequest	local	This operation raise a new request for the autoresponder
bmCardFormat	local	This operation returns the default card format for a Request card in the Board Manager App.
catalogAddServiceToFavourites	local	Used by the Core Service Catalog. Adds a Service to the session users favourites.
catalogGetBulletinList	local	Used by the Core Service Catalog. Returns a list of bulletins from the app
catalogGetFAQList	local	Used by the Core Service Catalog. Returns a list of FAQs from the app
catalogGetKnownIssueList	local	Used by the Core Service Catalog. Returns a list of FAQs from the app
catalogGetMyServiceRequestList	local	Used by the Core Service Catalog. Returns a list of Requests for the session user.
catalogGetService	local	Used by the Core Service Catalog. Returns Service Details from the application
catalogGetServiceFAQ	local	Used by the Core Service Catalog. Returns Service FAQ
catalogGetServiceList	local	Used by the Core Service Catalog. Returns a list of Services from the application
catalogGetServiceRequest	local	If you are allowed to view the related Service, the details of a specific Catalog Item are returned
catalogGetServiceRequestList	local	Used by the Core Service Catalog. Returns a list of Service Request items from the app
catalogRemoveServiceFromFavourites	local	Used by the Core Service Catalog. Removed a Service from the session users favourites.
catalogSearchService	local	- DEMO - Returns a list of services, Service Subtypes or/and existing service requests based on a query from the app
catalogSetServiceFAQLike	local	Used by the Core Service Catalog. Updates a particular FAQs feedback i.e. Liking, Disliking or removing your Feedback
catalogSetServiceKnownIssueMeToo	local	Used by the Core Service Catalog. Sets "Me Too" against a published request for the session user.
catalogSubmitServiceRequest	local	This operation raises a new Request. This operation is intended for Employee Portal only.
checkAppRightsGranted	local	This operation is now deprecated. Please use "checkRights" operation in "session" service instead.
cnvDurationToSeconds	local	This flowcode parses a duration value into its components for later manipulation
cnvSecondsToDuration	local	Converts a value in seconds to the corresponding duration value
convertRichTextToPlainText	local	Takes rich text and converts it to plaintext
coreHomeInitialiseData	global	DEPRECATED - Calls all applications and requests slides and home data
coreInitaliseData	global	For internal use only - Used by the Core Web App to get all the initial data need on first lost.
coreInitialiseData	global	For internal use only - Used by the Core Web App to get all the initial data need on first lost.
core_getProgressiveCaptureChangeTypes	local	This will return the change types available
core_getProgressiveCaptureConnections	local	Progressive Capture Connections template FC in preparation for Progressive Capture 2 API support
core_getProgressiveCaptureCustomerRequestTypes	local	This will return the request types available to a customer
core_getProgressiveCaptureReleaseTypes	local	This will return the change types available
core_getProgressiveCaptureRequestCategories	local	Progressive Capture Request Categories template FC in preparation for Progressive Capture 2 API support
core_getProgressiveCaptureRequestTypes	local	This will return the request types available
core_getProgressiveCaptureSites	local	Progressive Capture Sites template FC in preparation for Progressive Capture 2 API support
core_init_getProgressiveCaptureCustomerRequestType	local	This will return the default value of the customer request type
core_init_getProgressiveCaptureRequestCategories	local	This will return the default value of the customer request type
core_init_getProgressiveCaptureRequestType	local	This will return the request types available
devAppCreateAssessmentType	local	This operation creates an Assessment Type called 'Impact' when updating the Service Manager App.
devAppCreateIndex	local	Makes sure that the Service Manager indexes exists
devAppCreateProfiles	local	This operation creates default Request & Closure profiles.
devAppInstallSettings	local	On install, change settings to enable new functionality
devAppReports	local	Load Categories, and update/insert new reports
devAppSimpleLists	local	Make sure that each simple lists exists
devAppUpdateOrphanedViews	local	INTERNAL USE ONLY.
devAppUpdateRoles	local	Used to apply the default and necassary roles for the Service Manager application.
devAppUpdate_categoryAction	local	This is the description text for this flowcode operation
emailMessagePreview	local	This operation allows the user to see a preview of an email template.
evtOnTaskCreate	local	INTERNAL USE ONLY: This operation updates a Request on creation of a task.
fetchCoworkersExample	local	Progressive Capture Coworkers / Customer template FC in preparation for Progressive Capture 2 API support
getCoWokers	global	DEPRECATED - please use getCoworkersList
getCoWokersList	global	DEPRECATED - Please use getCoWorkersList
getCoWorkers	global	DEPRECATED - please use getCoworker
getCoWorkersList	global	For internal use only - Get a list of Co-workers
getContacts	global	DEPRECATED - use get contactsList
getContactsList	global	For internal use only - Get a list of contacts
getContactsList4	global	For internal use only - Get a list of contacts
getContactsListByOrgFilter	global	For internal use only - Get filtered and paged list of organisations
getConversations	global	This is the description text for this flowcode operation
getCustomButtonConfig	global	Load the config for the custombutton
getEmailList	global	DEPRECATED - For internal use only - Used to get email list (Paged) and count of emails.
getEmailList2	global	For internal use only - Used to get email list (Paged) and count of emails
getEmailUnreadCounter	global	For internal use only - Returns the unread email counter for all shared mailboxed bellonging to the logged in user
getLoginConfig	global	Load extra settings for SAML
getOrganisations	global	DEPRECATED - use getOrganisationList
getOrganisationsList	global	For internal use only - Get filtered and paged list of organisations
getPlaintextEmail	local	Get an email's context as plaintext. This flowcode will fetch the email and check for a plaintext version first. If this is found, it's parsed to remove any tags found and then returned. If no plaintext is found, the HTML content is parsed and returned.
getPriorityFromMatrix	local	This operation is deprecated.
getRelatedEntities	local	This flowcode is responsbile for returning the appropriate related entity data
getRoutingRuleTemplate	local	This operation gets the configurations of a Routing Rule template.
getSitesList	global	Get a list of Sites
getSystemSetting	local	This operation returns value of "api.xmlmc.queryExec.maxResultsAllowed" System Setting.
getUnreadCountersForPosts	global	DEPRECATED - For internal use only - Get unread counters for a list of activity Id
getUserBasicNotificationConfig	global	For internal use only - Returns user event configuration
getUserGuestRecord	global	This operation returns a customer's details, depending on whether they are a co-worker or a contact.
getUserMemberships	global	Returns the List of My Roles and Groups as URNs includding the same user URN
getUsersIManage	global	For internal use only - Returns the List of Users I manage based on Groups
getVisibility	local	This operation is deprecated. Please refer to https://api.hornbill.com/_types/activityVisibilityType for details about the activitity types available.
guestInitaliseData	global	Used by the Guest App to get all the initial data need on first lost.
guestInitialiseData	global	Used by the Guest App to get all the initial data need on first lost.
guestTermsAndConditionsGet	global	For internal use only - Used to get email list (Paged) and count of emails
hornbillRaiseIncident	local	This operation is intended for system use only.
knowledgeSearch	local	This flowcode is responsible for querying various entities and returning the relevant search results
knowledgeSearchSelfService	local	This operation is now deprecated.
knowledgeSearchSelfService2	local	This operation is now deprecated.
knowledgeSearchSelfService3	local	This flowcode is responsible for querying various entities via the portals and returning the relevant search results
portalsGlobalSearch	local	DEPRECATED: Use knowledgeSearchSelfService instead. This flowcode is responsible for querying the portals and returning the relevant search results.
postToTimeline	global	Make safe post to social object timeline, checking if user is following, if not doing it for him and unfollow.
procap_form_organisation	global	For internal use only - Returns the unread email counter for all shared mailboxed bellonging to the logged in user
reportManagerDefaultWidget	global	This flowcode operation returns default widget chart data for the specified default widget from the Hornbill Collaboration application.
reportManagerDefaultWidgetFolders	global	This flowcode operation returns default widget folders that are provied by the Hornbill Collaboration application
reportManagerDefaultWidgets	global	This flowcode operation returns default widget data for all default widgets that are provied by the Hornbill Collaboration application
reportManagerReportTemplates	global	This flowcode operation returns default report templates for the Hornbill Collaboration application
rssParser	global	For internal use only - Add all users to the specified role
sendMessage	global	Send message to specific urn array
setCustomButtonConfig	global	save the config for the custombutton
shrGetCustomerDetails	local	This operation returns a customer's details, depending on whether they are a co-worker or a contact.
shrGetTimestamp	global	This flowcode returns a new calculated timestamp value based on the input parameters provided.
shrGetVisibility	local	This operation is deprecated. Please refer to https://api.hornbill.com/_types/activityVisibilityType for details about the activitity types available.
smGetReport	local	This operation is used to run a report within Service Manager's Reports module.
test_contact_module	global	For internal use only - test contact module
test_entity_module	global	For internal use only - test entity module
test_xmlmc_module	global	For internal use only - test xmlmc module
timeSlcGet	global	For internal use only - Calendar Get
translateAddLanguage	local	This Global Flowcode is responsbile for adding a new translation against a currently existing entity
translateCreate	local	This Global Flowcode is responsbile for create a new unique translation for an entity
translateCreateDefault	local	This Global Flowcode is responsible for creating the default language version for an entity
translateData	local	This Global Flowcode is responsbile for translating the provide summary and description data from the source language to the target language using the Google Translate API
translateDelete	local	This Global Flowcode is responsbile for deleting either speicifc entity's translation or the whole entity and all its children translations
translateGetEntityDetails	local	The global flowcode is responsible for getting all the relevant entity translation details
translateGetLanguageOptions	local	This Global Flowcode is responsible for returning all languages the current entity has already been translated in as well as the other remaining languages that are available
translateUpdate	local	This Global Flowcode is responsible for updating a currently existing entity's translation record
translateUpdateFeature	local	This flowcode is responsible for updating a translatable entities specific features e.g. Services: h_available (portal visibility). Statuses: h_allow_use_on_auto_update
updateActivityStream	global	For internal use only - Unified access to the following APIs PostImage AcitvityPostImage ActivityPostMessage PostMessage
updateAppSettings	local	This operation is deprecated.
userUpdateProfile	global	For internal use only - Create new board
webrtc_answer	global	respond to a webrtc request
webrtc_getIceServer	global	Get ICE server configuration
webrtc_hangup	global	Message sent when a user hangs up or rejects a call to let other users know this
webrtc_joincall	global	join call and get list of users to initiate connection with
webrtc_offer	global	starts a webrtc call
webrtc_setIceCandidate	global	Send an ICE Candidate to the specified user
webrtc_startcall	global	Creates a peer 2 peer video (or other webrtc) call

The following general BPM operations are defined for the 'com.hornbill.servicemanager' application. You can click on each operation to see detailed information about that operation.

Method	Source	Description

The following general Auto Responder (AR) operations are defined for the 'com.hornbill.servicemanager' application. You can click on each operation to see detailed information about that operation.

Method	Source	Description

The following general events are defined for the 'com.hornbill.servicemanager' application. You can click on each event to see detailed information about that event.

Event	Source	Description