Methods
-
<static> getMenuItemList() → {Array.<MenuItem>}
-
Description
Retrieve the portal configuration object
Returns
-
<static> getIncidentTopic( params ) → {FormDefinition}
-
Description
Get Incident Topic details with all the data required to fill out an incident form
Parameters
Name Type Description paramsObject Selected topic from the DropDown (IncDef translation)
Name Type Description keyValuesys_id SysId of the incident topic
Returns
-
<static> getIncidentTopicList() → {ListItemPage}
-
Description
Retrieve a list of topics and categories with optional filters applied
Returns
-
<static> registerIncident( formDefinition ) → {FormResponse}
-
Description
Register an incident based on a topic form
Parameters
Name Type Description formDefinitionFormDefinition Returns
-
<static> getKnowledgeArticle( params ) → {KnowledgeArticle}
-
Description
Retrieve a Knowledge article by sysId or number
Parameters
Name Type Description paramsListItem Returns
-
<static> getKnowledgeList() → {ListItemPage}
-
Description
Get a list of articles and categories based on a filter
Returns
-
<static> addKnowledgeFeedback( feedback ) → {string}
-
Description
Add feedback to a knowledge article and returns
Parameters
Name Type Description feedbackObject Properties
Name Type Description feedback.articleSysIdsys_id feedback.commentstring feedback.usefulboolean Returns
-
<static> getMostViewedKnowledgeList() → {Array.<ListItem>}
-
Description
Gte a list of most viewed and recent articles
Returns
-
<static> registerCase( form ) → {FormResponse}
-
Description
Create a case from a submitted form
Parameters
Name Type Description formFormDefinition Submitted form
Returns
-
<static> lookupProduct( filter ) → {Array.<Choice>}
-
<static> lookupInstallBase( filter ) → {Array.<Choice>}
-
<static> getLastUsedRequestList() → {Array.<ListItem>}
-
Description
Get the last used requests (maximum 10)
Returns
-
<static> getRecentRequestList() → {Array.<ListItem>}
-
Description
Get the most recent rquested items
Returns
-
<static> _setFilterDefaults( filter ) → {FilterOptions}
-
Description
Set default filter values if not provided
Parameters
Name Type Description filterFilterOptions Returns
-
<static> getRequestItemList() → {ListItemPage}
-
Description
Get everything for the Request page
Returns
-
<static> getRequestItem( item ) → {Request}
-
<static> getPopularRequestList() → {Array.<ListItem>}
-
Description
Get a list of most used, latest used request items
Returns
-
<static> getPinnedArticleList() → {Array.<ListItem>}
-
Description
Get maximum 5 randomly pinned articles for this user
Returns
-
<static> getTicket( ticket ) → {Ticket}
-
Description
Retrieve details for a status ticket
Parameters
Name Type Description ticketListItem Returns
-
<static> addTicketComment( form ) → {FormResponse}
-
<static> getRecentIncidentList() → {Array.<ListItem>}
-
Description
Get the most recent activities on your incidents
Returns
-
<static> getTicketList( input ) → {Array.<ListItem>}
-
Description
Get a list of all tickets for the current user, limits to 5000 tickets per type, maximum 3 months old in updates
Parameters
Name Type Description inputQueryInput Returns
-
<static> getRecentTicketList() → {Array.<ListItem>}
-
Description
Get a list of recent tickets for interest of the user, eg based on changes, status etc.
Returns
-
<static> lookupUser( filter ) → {Array.<ListItem>}
-
Description
Lookup a user based on the provider filter (always in users own company)
Parameters
Name Type Description filterFilterOptions Returns
-
<static> lookupCI( filter ) → {Array.<ListItem>}
-
Description
Lookup a CI based on the provider filter (always in users own company)
Parameters
Name Type Description filterFilterOptions Returns
-
<static> lookupService( filter ) → {Array.<ListItem>}
-
Description
Lookup a CI based on the provider filter (always in users own company)
Parameters
Name Type Description filterFilterOptions Returns
-
<static> submitSurvey( survey ) → {FormResponse}
-
Description
Submit the results of a survey taken
Parameters
Name Type Description surveyObject Properties
Name Type Description survey.surveySurvey survey.valuesObject Returns
-
<static> getSurvey( input ) → {Survey}
-
Description
Retrieve a survey that is relevant for the provided input, delivers a null object if nothing relavant was found. The Survey will always be relevant or targeted at the current user
Parameters
Name Type Description inputObject Properties
Name Type Description input.documentIdsys_id | undefined Provide a document Id if survey must be related to it
input.ticketTypeTicketType | undefined Restrict searches to only a particular ticket type
input.startedboolean | undefined Restrict to started surveys only
Returns
-
<static> setLanguage( input )
-
Description
Change the session/user language
Parameters
Name Type Description inputObject Properties
Name Type Description languageLanguagType -
<static> addFeedback( form ) → {FormResponse}
-
<static> registerComplaint( form ) → {FormResponse}
-
<static> updateApproval( input ) → {string}
-
Description
Update Approval data
Parameters
Name Type Description inputObject Properties
Name Type Description input.keyValuesys_id input.action"comment" | "reject" | "approve" input.commentstring Returns
-
<static> uploadAttachment( input ) → {Array.<Attachment>}
-
Description
Upload attachment for a document and returns the updated attachment list
Parameters
Name Type Description inputAttachmentInput Returns
-
<static> clearAttachments( input ) → {Array.<Attachment>}
-
Description
Clear all attachments from a document and returns the updated (should be empty) attachment list
Parameters
Name Type Description inputAttachmentInput Returns
-
<static> removeAttachment( input ) → {Array.<Attachment>}
-
Description
Remove attachment for a document and returns the updated attachment list
Parameters
Name Type Description inputAttachmentInput Returns
-
<static> updateAttachment( input ) → {Object}
-
Description
Update attachment for a document and returns the updated attachment list
Parameters
Name Type Description inputAttachmentInput Returns