Application - com.hornbill.servicemanager
Entities
The following entities are defined for this applicationAssessment
The following operations are defined for the 'Assessment' entity.
Operation | Description |
---|---|
addAssessment | This flowcode operation adds a new assessment. |
addAssessmentTranslation | This flowcode operation adds a new translation for the specified assessment. |
copyAssessment | This flowcode operation creates a new assessment based on the existing specified assessment. |
deleteAllAssessments | This flowcode operation deletes all existing assessments. |
deleteAssessment | This flowcode operation deletes an existing assessment. |
deleteAssessmentTranslation | This flowcode operation deletes an existing assessment translation. |
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 |
getAssessmentTranslations | This flowcode operation gets details of all translations for the specified assessment. |
getAssessments | This flowcode operation gets details of all assessments based on the search criteria provided. |
updateAssessment | This flowcode operation updates an existing assessment. |
AssessmentAnswers
The following operations are defined for the 'AssessmentAnswers' entity.
Operation | Description |
---|---|
addAssessmentQuestionAnswer | This flowcode operation adds a new answer to the specified assessment question. |
addAssessmentQuestionAnswerTranslation | This flowcode operation adds a new translation for the specified assessment question answer. |
deleteAllAssessmentQuestionAnswers | This flowcode operation deletes all existing assessment question answers. |
deleteAssessmentQuestionAnswer | This flowcode operation deletes an existing assessment question answer. |
deleteAssessmentQuestionAnswerTranslation | This flowcode operation deletes an existing assessment question answer translation. |
get | This flowcode is responsible for returning all the applicable Assessment Answer(s) |
getAssessmentQuestionAnswerTranslations | This flowcode operation gets details of all translations for the specified assessment question answer. |
getAssessmentQuestionAnswers | This flowcode operation gets details of all answers for the specified assessment question based on the search criteria provided. |
updateAssessmentQuestionAnswer | This flowcode operation updates an existing assessment question answer. |
updateAssessmentQuestionAnswersOrder | This flowcode operation updates the order of existing assessment question answers. |
AssessmentQuestions
The following operations are defined for the 'AssessmentQuestions' entity.
Operation | Description |
---|---|
addAssessmentQuestion | This flowcode operation adds a new assessment question. |
addAssessmentQuestionTranslation | This flowcode operation adds a new translation for the specified assessment question. |
deleteAllAssessmentQuestions | This flowcode operation deletes all existing assessment questions. |
deleteAssessmentQuestion | This flowcode operation deletes an existing assessment question. |
deleteAssessmentQuestionTranslation | This flowcode operation deletes an existing assessment question translation. |
get | This flowcode is responsible for returning all the applicable Assessment Question(s) |
getAssessmentQuestionTranslations | This flowcode operation gets details of all translations for the specified assessment question. |
getAssessmentQuestions | This flowcode operation gets details of all questions for the specified assessment based on the search criteria provided. |
updateAssessmentQuestion | This flowcode operation updates an existing assessment question. |
updateAssessmentQuestionsOrder | This flowcode operation updates the order of existing assessment questions. |
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 |
entityAttachGetInfo | This operation returns details for a asset 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. |
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 operation returns a user's assets to be displayed in the My Profile area. The operation provides filtering options including the ownership type of an asset. |
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 loads 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. |
searchAssetGlobalTag | This will search the assets by tag |
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. |
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'. |
AssetsComputer
The following operations are defined for the 'AssetsComputer' entity.
Operation | Description |
---|---|
addAssetComputer | This flowcode operation creates 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'. |
AssetsInstalledSoftware
There are no operations or events defined for the 'AssetsInstalledSoftware' entity.
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'. |
AssetsNetworkDevice
The following operations are defined for the 'AssetsNetworkDevice' entity.
Operation | Description |
---|---|
addAssetNetworkDevice | This flowcode operation creates 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'. |
AssetsSoftware
The following operations are defined for the 'AssetsSoftware' entity.
Operation | Description |
---|---|
addAssetSoftware | This flowcode operation creates 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'. |
AssetsTypes
The following operations are defined for the 'AssetsTypes' entity.
Operation | Description |
---|---|
addType | This operation creates an Asset type record. The name, description, icon, prefix and the configuration of the visible and mandatory asset attributes can be set. |
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 operation updates an Asset type record. The name, description, icon, prefix and the configuration of the visible and mandatory asset attributes can be updated. |
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 operation adds a member of type user or team 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. |
migrateBoard | This migrate a SM Board to Board Manager App |
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 |
Catalogs
The following operations are defined for the 'Catalogs' entity.
Operation | Description |
---|---|
delete | This operation removes and dissociates a catalog item from a service. |
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. |
excludeSubscription | This operation exclude a service's subscription from a catalog |
includeSubscription | This operation include a service's subscription 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 |
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. |
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 |
ConfigurationItemsDependency
There are no operations or events defined for the 'ConfigurationItemsDependency' entity.
ConfigurationItemsImpact
There are no operations or events defined for the 'ConfigurationItemsImpact' entity.
ConfigurationItemsInPolicy
There are no operations or events defined for the 'ConfigurationItemsInPolicy' entity.
Contact
There are no operations or events defined for the 'Contact' 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
There are no operations or events defined for the 'Container' 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. |
FaqAttachments
The following operations are defined for the 'FaqAttachments' 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 an article attachment |
download | Increment download counts for an attachment |
read | Takes a JSON string of attachments that already exist on the server and apply these to a request |
reset | Resets the download count for the documents against the article |
update | Takes a JSON string of attachments that already exist on the server and apply these to a request |
FaqKnowledgebases
The following operations are defined for the 'FaqKnowledgebases' entity.
Operation | Description |
---|---|
createKnowledgebase | This operation returns the Faqs that belong to a Service. |
deleteKnowledgebase | This operation removes the Knowledgebase and any associated Topics |
getAssociatedEntities | This operation returns the Faqs that belong to a Service. |
getKnowledgebase | This operation returns Knowledge. |
getKnowledgebaseTags | This operation returns list of all knowledgebase tags, with option filter by name. |
listKnowledgebases | This operation returns Topics. |
loadSearchPage | This operation returns Topics. |
FaqKnowledgebaseTranslations
There are no operations or events defined for the 'FaqKnowledgebaseTranslations' entity.
Faqs
The following operations are defined for the 'Faqs' entity.
Operation | Description |
---|---|
addAttachment | Takes a JSON string of attachments that already exist on the server and apply these to a request |
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 |
faqCreate | This Global Flowcode is responsible for updating a currently existing entity's translation record |
faqUpdate | This Global Flowcode is responsible for updating a currently existing entity's translation record |
getAssociatedEntities | This operation returns the Faqs that belong to a Service. |
getAttachments | This returns the attachments for a given FAQ |
getFaqCountGroupedByKbasePath | This operation returns the Faqs that belong to a Service. |
getFaqManagementList | This operation returns the Faqs that belong to a Service. |
getFaqs | This operation returns the Faqs that belong to a Service. |
getFaqsPortal | This operation returns the Faqs that belong to a Service. |
getKnowledgeFaqs | Get list of knowledge faqs |
migrateKnowledgebase | Get list of knowledge faqs |
searchConsumerFaqs | This operation returns the Faqs that belong to a Service. |
updateManualOrder | This returns the attachments for a given FAQ |
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 |
FaqsRelations
The following operations are defined for the 'FaqsRelations' entity.
Operation | Description |
---|---|
addRelation | This operation returns the Faqs that belong to a Service. |
removeRelation | This operation returns the Faqs that belong to a Service. |
FaqsTranslations
There are no operations or events defined for the 'FaqsTranslations' entity.
FaqTopics
The following operations are defined for the 'FaqTopics' entity.
Operation | Description |
---|---|
createTopic | This operation returns the Faqs that belong to a Service. |
deleteTopic | This operation removes the Topic |
getAssociatedEntities | This operation returns the Faqs that belong to a Service. |
getTopic | This operation returns Topics. |
listTopics | This operation returns Topics. |
loadLandingPage | This operation returns Topics. |
FaqTopicsRelations
The following operations are defined for the 'FaqTopicsRelations' entity.
Operation | Description |
---|---|
addRelation | This operation returns the Faq Topics that belong to a Service. |
removeRelation | This operation returns the Faqs that belong to a Service. |
FaqTopicsTranslations
There are no operations or events defined for the 'FaqTopicsTranslations' entity.
FaqTypes
The following operations are defined for the 'FaqTypes' entity.
Operation | Description |
---|---|
updatePrefix | This update the prefix for a FAQ Type |
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. |
smGetCustomFilters2 | Get a list of Views for a user |
Impact
The following operations are defined for the 'Impact' entity.
Operation | Description |
---|---|
addImpact | This flowcode operation adds a new impact. |
addImpactTranslation | This flowcode operation adds a new translation for the specified impact. |
deleteImpact | This flowcode operation deletes an existing impact. |
deleteImpactTranslation | This flowcode operation deletes an existing impact translation. |
get | This flowcode is responsbile for returning the applicable Impact(s) |
getImpactTranslations | This flowcode operation gets details of all translations for the specified impact. |
getImpacts | This flowcode operation gets details of all impacts that match the search criteria provided. |
updateImpact | This flowcode operation updates an existing impact. |
updateImpactOrder | This flowcode operation updates the order of existing impacts. |
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 an Incident properties |
KnowledgeBaseArticle
The following operations are defined for the 'KnowledgeBaseArticle' entity.
Operation | Description |
---|---|
createArticle | This creates a new Knowledge Base Article |
createTranslation | This creates a new Knowledge Base Article |
deleteArticle | This allows a user to delete an article |
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. |
getArticle | This returns a list of all articles for a knowledgebase |
getArticles | This returns a list of all articles for a knowledgebase |
getGraphData | This gets graph info for an article |
loadOverview | This gets stats info for an article |
moveArticle | This moves the articles to another topic |
rate | This allows a user to rate the article |
reset | Resets the view counts for the article |
updateArticle | This updates a Knowledge Base Article |
KnowledgeBaseArticleActivity
There are no operations or events defined for the 'KnowledgeBaseArticleActivity' entity.
KnowledgeBaseArticleActivityDownload
There are no operations or events defined for the 'KnowledgeBaseArticleActivityDownload' entity.
KnowledgeBaseArticleActivityLink
There are no operations or events defined for the 'KnowledgeBaseArticleActivityLink' entity.
KnowledgeBaseArticleDocuments
The following operations are defined for the 'KnowledgeBaseArticleDocuments' 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 an article attachment |
download | Increment download counts for an attachment |
read | Takes a JSON string of attachments that already exist on the server and apply these to a request |
reset | Resets the download count for the documents against the article |
systemAttachFileFromSession | Takes a JSON string of attachments that already exist on the server and apply these to a request |
KnowledgeBaseArticleLinks
The following operations are defined for the 'KnowledgeBaseArticleLinks' entity.
Operation | Description |
---|---|
add | Takes a link and display text and apply these to a article |
delete | This flowcode delete an article link |
navigate | Increment click counts for an link |
reset | Resets the click count for the links against the article |
KnowledgeBaseArticleRating
There are no operations or events defined for the 'KnowledgeBaseArticleRating' entity.
KnowledgeBaseArticleRelations
The following operations are defined for the 'KnowledgeBaseArticleRelations' 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 disassociates a related article |
read | Takes a JSON string of attachments that already exist on the server and apply these to a request |
KnowledgeBaseArticleTranslated
There are no operations or events defined for the 'KnowledgeBaseArticleTranslated' entity.
KnowledgeBaseAssets
The following operations are defined for the 'KnowledgeBaseAssets' entity.
Operation | Description |
---|---|
addKbAsset | This adds a asset for the Knowledge Base |
getKbAssets | This returns a list of assets for the Knowledge Base |
removeKbAssets | This removes a asset record associate to a Knowledge Base |
KnowledgeBaseContributors
The following operations are defined for the 'KnowledgeBaseContributors' entity.
Operation | Description |
---|---|
addKbContributor | This adds a contributor for the Knowledge Base |
getKbContributors | This returns a list of contributors for the Knowledge Bas |
removeKbContributor | This removes a contributors of a Knowledge Base |
KnowledgeBaseManager
The following operations are defined for the 'KnowledgeBaseManager' entity.
Operation | Description |
---|---|
addKbManagers | This adds a manager for the Knowledge Center |
getKbManagers | This returns a list of managers for the Knowledge Center |
removeKbManager | This removes a manager of a Knowledge Center |
KnowledgeBaseRelations
There are no operations or events defined for the 'KnowledgeBaseRelations' entity.
KnowledgeBases
The following operations are defined for the 'KnowledgeBases' entity.
Operation | Description |
---|---|
createKB | This creates a new Knowledge Base |
deleteTopic | This deletes a Knowledge Base Topic |
getKB | This returns a Knowledge Base |
getKBs | This returns a Knowledge Base or all Knowledge Bases |
loadCenter | This returns the knowledge center landing page data |
moveTopic | This moves the topic to be a child of another topic |
updateKbase | This creates a new Knowledge Base |
updateTopic | This creates a new Knowledge Base |
updateTopicOrder | This updates the order of the topics |
KnowledgeBaseSearch
The following operations are defined for the 'KnowledgeBaseSearch' entity.
Operation | Description |
---|---|
search | Search Knowledge Base Articles |
updateSearch | This updates a Knowledge Base Search |
KnowledgeBaseSearchResults
There are no operations or events defined for the 'KnowledgeBaseSearchResults' entity.
KnowledgeBaseSearchTags
There are no operations or events defined for the 'KnowledgeBaseSearchTags' entity.
KnowledgeBaseServices
The following operations are defined for the 'KnowledgeBaseServices' entity.
Operation | Description |
---|---|
addKbService | This adds a service for the Knowledge Base |
getKbServices | This returns a list of services for the Knowledge Base |
removeKbServices | This removes a service record associate to a Knowledge Base |
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. |
Priority
The following operations are defined for the 'Priority' entity.
Operation | Description |
---|---|
addPriority | This operation adds a new Priority record. |
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 an entity Problems |
Products
The following operations are defined for the 'Products' entity.
Operation | Description |
---|---|
addProduct | This operation creates a product record. This is used when managing vendors, products and versions in the Asset Management area. |
deleteProduct | This operation removes a product record. |
getProduct | This parameter returns the products against a vendor in the system. |
updateProduct | This operation updates a product record. This is used when managing vendors, products and versions in the Asset Management area. |
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. |
pc2Analysts | This operation is used to return a list of the all the Analyst(s) depending on the filters provided |
pc2Assets | This operation is used to return a list of the all the Asset(s) depending on the filters, configuration and parameters provided |
pc2AssetsClassAndTypes | This operation is used to return a list of the all of the Asset Classes, Types and Relationships |
pc2CustomerSearch | This operation is used to return a list of the all the Customer(s) depending on the filters provided |
pc2CustomerSearchResults | This operation is used to return all of the Customer's details, including all of their associated requests |
pc2LogProcapture | This operation loads in and processes all the payload data returned from the Progressive Capture forms to raise a new Request |
pc2Organisations | This operation is used to return all of the Organisation's details |
pc2RequestCategories | This operation is used to return a list of the all the Request Categories depending on the filters provided |
pc2RequestTypes | This operation is used to return a list of the all the Reques Types(s) depending on the filters provided |
pc2Services | This operation is used to return a list of the all the Services(s) depending on the filters provided |
pc2Sites | This operation is used to return a list of the all the Site(s) depending on the filters 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 |
getKnowledgeErrors | Get list of knowledge Known Errors |
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 operation returns the Questions entries for a Request. |
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 |
get | This flowcode is responsible for 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 |
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. |
addRelationshipLink | This flowcode operation adds a new relationship link. |
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. |
deleteAllRelationshipLinks | This flowcode operation deletes all existing relationship links. |
deleteRelationshipLink | This flowcode operation deletes an existing relationship link. |
get | This flowcode is responsible for querying and returning a list of relationship links |
getRelationshipLinks | This flowcode operation gets details of all relationship links based on the search criteria provided. |
update | This operation updates an existing Relationship Link. |
updateRelationshipLink | This flowcode operation updates an existing relationship link. |
RelationshipTypes
The following operations are defined for the 'RelationshipTypes' entity.
Operation | Description |
---|---|
addRelationshipType | This flowcode operation adds a new relationship type. |
addRelationshipTypeTranslation | This flowcode operation adds a new translation for the specified relationship type. |
delete | This operation deletes a Relationship Type, if it is not in use by one or more Relationship Links. |
deleteAllRelationshipTypes | This flowcode operation deletes all existing relationship types. |
deleteRelationshipType | This flowcode operation deletes an existing relationship type. |
deleteRelationshipTypeTranslation | This flowcode operation deletes an existing relationship type translation. |
get | This flowcode is responsible for querying and returning a list of relationship types |
getRelationshipTypeTranslations | This flowcode operation gets details of all translations for the specified relationship type. |
getRelationshipTypes | This flowcode operation gets details of all relationship types based on the search criteria provided. |
updateRelationshipType | This flowcode operation updates an existing relationship type. |
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. DEPRECATED: use Requests.smGetAttachments instead |
requestAttachmentsCount | This operation returns the number of request attachment the session user is allowed to see |
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 |
getRequestCustomerFeedback | This flowcode return a request's feedback |
queryExec | DEPRECATED. Use RequestFeedback::getRequestCustomerFeedback instead. |
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
The following operations are defined for the 'RequestHistoricEmail' entity.
Operation | Description |
---|---|
getHistoricEmail | This operation returns the email record associated to a historic request update entry |
RequestHistoricUpdateAttachments
The following operations are defined for the 'RequestHistoricUpdateAttachments' entity.
Operation | Description |
---|---|
entityAttachGetInfo | This operation returns details for a historic update 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. |
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. |
RequestNotices
The following operations are defined for the 'RequestNotices' entity.
Operation | Description |
---|---|
createRequestNotice | This operation create an entity RequestNotices |
deleteRequestNotice | This operation delete an entity RequestNotices |
getRequestNotice | This operation returns a list of entities RequestNotices |
selfserviceGetRequestNotice | This operation returns a list of entities RequestNotices to display in the portals |
updateRequestNotice | This operation update an entity RequestNotices. At least one among the input params type, text, visibility must be set. |
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 |
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. |
copy | This operation creates a copy of a request |
core_logProgressiveCapture | This flowcode is responsible for processing the progressive capture payload and raising a request |
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. |
getManagedStaffRequests | This operation returns the reqursts for users that the logged-on person manages. |
getOwnershipDetails | This flowcode return details about a request's owner |
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. |
getRequestDetails | This operation returns the details of a Request and the related entities. NOTE: This operation is also used in com.hornbill.timesheet.manager |
getRequestListWidgetConfig | This operation loads the widget (Employee Portal) setup |
getRequestPreview | This operation returns the preview data for a Request. This is used in the requests list popover. |
getRequestRecord | This operation returns the details of a Request and , optionally, the related entities |
getRequestServiceFaqs | This operation returns the Faqs that are associated to the Request's service. There are filtering and pagination options available. |
getVisibilityLevel | This operation returns the logged-on person's visibility to a Request. |
guestGetConnectedRequests | This flowcode load the requests the user is connected to, in the Customer Portal |
guestGetFeedbackTimer | This flowcode return a request's feedback timer |
guestGetRequests | This flowcode load the requests visible in the Customer Portal |
guestGetTimelineAccessToken | This flowcode operation gets the request access token for the specified request. |
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, ...] |
linkAssetsToRequest | This operation is used to link one or more Assets to a Request |
linkRequests | This operation links 2 requests |
liveChatTranscriptGet | Return the transcript of a chat |
liveChatTranscriptUpdate | Update the transcript of a chat |
logRequest | This operation creates a new Request using the supplied information. |
logRequestBPM | This operation spawns a business process for the supplied Request. |
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 |
resolveLinkedRequest | This operation provides configurable options to resolve Linked Requests in a Request. |
resolveRequest | This operation resolves a Request. |
searchAssets | This operation return a list of assets, and whether they are associated with the request |
searchHistoricUpdates | This flowcode operation searches request historic updates for the lucene search query provided. |
searchRequests | This operation searches requests in the system using the filtering options provided. The indexer service is used to perform the search. |
searchTimeline | This operation searches request timelines in the system using the filtering options provided. The indexer service is used to perform the search. |
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 agents when an action is performed via the Self Service. |
selfserviceOnTimelineUpdate | 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. |
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 |
selfserviceResumeBPM | This operation is capable of resuming the BPM of a Request, with the option to resume linked Requests. |
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. |
selfserviceUpdateStatus | This flowcode is used to update the request status from a customer update |
selfserviceUpdateTimeline | Posts to the activity stream |
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. |
smGetAssetsByUser | This operation returns shared assets that the supplied user is a user of |
smGetAssetsSharedWithUser | This operation returns shared assets that the supplied user is a user of |
smGetAttachments | This operation returns the attachments for a Request. |
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, with the additional informations h_workaroud for PMs and h_steps_to_resolve for KEs |
smGetReqBoards | This operation is now deprecated. |
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 filters Requests based on the supplied conditions. Only the Requests that the logged-on person is allowed to access will be returned. Access is determined by the supported services, teams membership and application rights to access Request types. |
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). |
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. |
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 | DEPRECATED : This flowcode processes the Rule Conditions configured against the chosen service using the data within the request |
smSLMGetServiceLevelProcessValue | DEPRECATED : This flowcode processes the value of a Rule Condition configured against the chosen service using the data within the request |
smSLMProcessSLChange | This operation 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 |
smSLMTimerPause | This flowcode will pause a given request timer |
smSLMTimerResume | This flowcode will resume a given paused request timer |
smSendMessage | This operation sends an email from within a Request. |
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 |
smUpdateUrgency | This operation updates the request's urgency |
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. |
systemBpmSuspendAddNotice | FOR INTERNAL USE ONLY: This operation should not be invoked directly. Please use the operation 'createRequestNotice' in "RequestNotices" entity instead. |
systemBpmSuspendRemoveNotice | FOR INTERNAL USE ONLY: This operation should not be invoked directly. Please use the operation 'deleteRequestNotice' in "RequestNotices" 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. |
updateResolutionDetails | This operation updates the resolution details of a Request. |
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 Request Service Level |
RequestSLMChanges
There are no operations or events defined for the 'RequestSLMChanges' entity.
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 |
getRequestSLMEvents | This operation get service level events for a specific request and target |
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 operation create service level events for a specific request target |
RequestSLMTargets
The following operations are defined for the 'RequestSLMTargets' entity.
Operation | Description |
---|---|
create | This operation creates a 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 operation creates a platform timer and associates it to a request for managing request target timings |
RequestTypes
There are no operations or events defined for the 'RequestTypes' entity.
ResponseTimes
There are no operations or events defined for the 'ResponseTimes' entity.
RoutingRuleTemplates
The following operations are defined for the 'RoutingRuleTemplates' entity.
Operation | Description |
---|---|
addRoutingRuleTemplate | This operation creates a Routing Rule template. |
deleteAllRoutingRuleTemplates | This flowcode operation deletes all existing routing rule templates. |
deleteRoutingRuleTemplate | This operation deletes a Routing Rule template. |
getRoutingRuleTemplates | This flowcode operation gets details of all routing rule templates based on the search criteria provided. |
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 |
ServiceDesk
There are no operations or events defined for the 'ServiceDesk' entity.
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 |
---|---|
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 |
ServiceLevelDiagnosticsLog
The following operations are defined for the 'ServiceLevelDiagnosticsLog' entity.
Operation | Description |
---|---|
createLogEntry | Creates a service level diagnostic log entry |
getLogEntries | This operation returns SLM diagnostic log entries |
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 |
systemGetServiceRequestConfiguration | FOR INTERNAL USE ONLY: This operation should not be invoked directly. Please use "getServiceRequestConfiguration" 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 |
---|---|
addOrUpdateServiceRequestForm | This flowcode is reponsible for creating / updating the Service Request Details Form record |
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 |
updateServiceRequestDetails | This flowcode update an entity ServiceRequestDetails used to configure some request properties when the request is raised against a service |
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 |
---|---|
adminGetConfigVariationData | Gets the configuration data related to actions, workflow, sub states, catalog items and customer feedback organised by request type for all active services on the instance. |
adminGetGroupedServiceCounts | Counts the number of services on the instance grouped by the given criteria. |
adminGetMappingOverviewData | Get the data related to how many services on the instance allow each type of request to be logged against them |
adminGetRequestTypeActionConfigData | This flowcode operation is for admin use only. Gets the data related to action configurations for the given request type |
adminGetRequestTypeWorkflowData | Gets the data related to workflows for the given request type |
adminGetServices | Gets basic details of the services on the instance that match the given criteria |
adminUpdateServices | Updates the service configurations that match the given criteria with the given data |
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 |
determineMostInDemandServices | Determine the services with the top five most requests logged in the previous 12 months |
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. |
onServiceCreate | This operation creates the related records to a Service record. |
onServiceDelete | This operation deletes the related records to a Service record. |
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. |
smCreateService2 | This operation creates a new Service. |
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 operation returns the services list to show in the 'Service Details' progressive capture form. The subscription is filtered by site and customer. In both cases, only the services that the logged-on person supports are shown. |
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) |
smGetServicesMonthlyChartData | Get the data required for the given services chart name |
smGetServicesSubscribedBySite | This operation is responsbile for returning a list of Service(s) which have the supplied Site associated to them |
smGetServicesSubscriptionChartData | Get the data required for the Service Portfolio Subscriptions Chart |
smGetSubscribers | This operation returns the subscribers of a Service. |
smGetSupportedOrSubscribedServices | This flowcode is responsible for querying and returning a list of all the applicable subscribers against a service based on the input query |
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
There are no operations or events defined for the 'ServiceStatus' entity.
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 |
getMultiple | Get the Service Status History required for the Service Portfolio Availability chart |
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 |
---|---|
getServiceOwner | This operation returns the owner of a service. |
updateServiceOwner | This operation updates the service's owner. |
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. |
removeOrphanRecords | This operation returns the assignable supporting teams in a Service. When a Service is not supplied, the assignable teams in the system are returned. |
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 |
Sites
There are no operations or events defined for the 'Sites' entity.
SLC
There are no operations or events defined for the 'SLC' entity.
SmLogging
The following operations are defined for the 'SmLogging' entity.
Operation | Description |
---|---|
add | This operation adds a log entry to SM logging. |
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 |
---|---|
addStatus | This flowcode operation adds a new global status. |
addStatusTranslation | This flowcode operation adds a new translation for the specified status. |
deleteAllStatuses | This flowcode operation deletes all existing global request sub statuses. |
deleteStatus | This flowcode operation deletes an existing status. |
deleteStatusTranslation | This flowcode operation deletes an existing status translation. |
getStatusTranslations | This flowcode operation gets details of all translations for the specified status. |
getStatuses | This flowcode operation gets details of all global request sub statuses that match the search criteria provided. |
read | This flowcode returns sub-status levels which can be filtered by language, service, request type and parent status |
updateStatus | This flowcode operation updates an existing status. |
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.
Urgency
The following operations are defined for the 'Urgency' entity.
Operation | Description |
---|---|
addUrgency | This flowcode operation adds a new urgency. |
addUrgencyTranslation | This flowcode operation adds a new translation for the specified urgency. |
deleteUrgency | This flowcode operation deletes an existing urgency. |
deleteUrgencyTranslation | This flowcode operation deletes an existing urgency translation. |
getUrgencies | This flowcode operation gets details of all urgencies that match the search criteria provided. |
getUrgencyLevels | Return the list of Urgency levels |
getUrgencyTranslations | This flowcode operation gets details of all translations for the specified urgency. |
updateUrgency | This flowcode operation updates an existing urgency. |
updateUrgencyOrder | This flowcode operation updates the order of existing urgencies. |
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 | This operation creates a vendor record. This is used when managing vendors, products and versions in the Asset Management area. |
deleteVendor | This operation removes a vendor record. |
getVendor | This operation returns the vendor(s) in the system. |
updateVendor | This operation updates a vendor record. This is used when managing vendors, products and versions in the Asset Management area. |
Versions
The following operations are defined for the 'Versions' entity.
Operation | Description |
---|---|
addVersion | This operation associates a product to a vendor. |
deleteVersion | This operation removes the association between a product and a version. |
updateVersion | This operation updates the version attribute in an existing product version relationship from the 'h_itsm_product_versions' table. |
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 |
---|---|---|
appCoreInitialiseData | local | This operation returns the initialise data for the application. |
appGuestInitialiseData | local | This operation is called on Customer Portal / Service Portal login and aims to make an object available to the Front-end espData object. This operation is internal only and should not be used in integrations or other areas of 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. |
catalogSearchHistoryAdd | local | Log a new entry in the search history (Customer Portal) |
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. |
chatbotCancelRequest | local | EXPERIMENTAL - This operation cancels a request. For use with chatbot integrations. |
chatbotGetAssets | local | EXPERIMENTAL - This operation retrieves a list of assets owned by the defined user, and optionally used by & shared by. For use with chatbot integrations. |
chatbotGetRecentRequests | local | EXPERIMENTAL - This operation returns details about customers recent requests. For use with chatbot integrations. |
chatbotGetRequestStatus | local | EXPERIMENTAL - This operation returns basic details about a customers request. For use with chatbot integrations. |
chatbotGetSimpleList | local | EXPERIMENTAL - This operation retrieves a simple list as a JSON array. For use with chatbot integrations. |
chatbotKnowledgeSearch | local | EXPERIMENTAL - This operation is responsible for querying various entities via chatbot integrations, and returns relevant search results |
chatbotLogRequest | local | EXPERIMENTAL - This operation logs a new Incident or Service Request. For use with chatbot integrations. |
chatbotSetMeToo | local | EXPERIMENTAL - This operation sets or removes the Me Too flag against a published request. For use with chatbot integrations. |
chatbotUpdateReqTimeline | local | EXPERIMENTAL - This operation posts an update to a Request's Timeline. For use with chatbot integrations. |
checkAppRightsGranted | local | This operation is now deprecated. Please use "checkRights" operation in "session" service instead. |
cm_getEntitiesLinkedToAsset | local | This flowcode return the entities linked to an asset |
cm_getEntitiesLinkedToRequest | local | This flowcode return the entities linked to a request |
cm_getEntitiesLinkedToService | local | This operation return the list of entities linked to a service |
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 |
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_getProgressiveCaptureSites_extra_details | local | This Progressive Capture 2 operation returns additional Site Details information depending on the extraJSONParams object provided |
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 | This operation creates Service Manager's lucene indexes. |
devAppCreateProfiles | local | This operation creates default Request & Closure profiles. |
devAppCreateReportCategories | local | Load Categories, and update/insert new reports |
devAppCreateSimpleLists | local | Make sure that each simple lists exists |
devAppCreateUrgencyLevels | local | This operation creates the default Urgency levels (Critical,High,Medium,Low) when updating the Service Manager App. |
devAppPublishProcaptures | local | This operation creates the default progressive capture. |
devAppUpdateFaqKnowledgebases | local | This operation update the filters on the report instances by adding the organization ID where one or more organizations are added to the filtering criteria |
devAppUpdateFaqs | local | This operation update the filters on the report instances by adding the organization ID where one or more organizations are added to the filtering criteria |
devAppUpdateGenericFilters | local | This operation update the filters on the request list by adding the organization ID where one or more organizations are added to the filtering criteria |
devAppUpdateRemoveInPolicyDuplicates | local | Remove the duplicates (h_entity_id, h_entity_name) from the table h_cmdb_config_items_in_policy |
devAppUpdateReportInstances | local | This operation update the filters on the report instances by adding the organization ID where one or more organizations are added to the filtering criteria |
devAppUpdateSettings | local | On install, change settings to enable new functionality |
emailMessagePreview | local | This operation allows the user to see a preview of an email template. |
entityGetRecord | local | This operation returns the required data from other applications that are displayed in the explorer option within the Service Manager application. |
evtOnTaskCreate | local | INTERNAL USE ONLY: This operation updates a Request on creation of a task. |
getDefaultWidget | local | This flowcode operation returns default widget data for the specified default widget from the Hornbill Service Manager application. |
getDefaultWidgetQuery | local | This flowcode operation returns data for the specified default widget query from the Hornbill Service Manager application. |
getDefaultWidgetStructure | local | This flowcode operation returns the default widget structure for the stated Hornbill location for the Hornbill Service Manager application |
getDefaultWidgets | local | This flowcode operation returns the default widgets for the stated Hornbill location for the Hornbill Service Manager application |
getEntitiesLinkedToAsset | local | This flowcode return the entities linked to an asset |
getEntitiesLinkedToRequest | local | This flowcode return the entities linked to a request |
getEntitiesLinkedToService | local | This flowcode return the entities linked to a service |
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. |
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. |
getSharedMailboxList | local | Return the list of hared mailboxes the session user can access. |
getTagTranslations | local | This flowcode operation gets all translations for the specified tag. |
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. |
knowledgeSearchSelfService3 | local | This flowcode is responsible for querying various entities via the portals and returning the relevant search results |
organizationGetDetails | local | This operation returns details about an organization. |
shrGetCustomerDetails | local | This operation returns a customer's details, depending on whether they are a co-worker or a contact. |
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. |
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 |
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 |
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 |
---|