Overview

Calls must be made by an authenticated user via custom tasks within the portal or by adding a Authorization Header containing: Token XXXXX Where XXXXX is your authentication token. If your portal website is setup for Windows Authentication you must also enable Anonymous Authentication to utilize the Api.

For additional help you can view the Api Examples Document.

ArticleType

No Documentation For Controller Yet

Type Name Endpoint
GET Get api/V3/ArticleType/Get

Description: Gets all root article types

ArticleComment

endpoint to retrieve, update, and delete Knowledge Article comments

Type Name Endpoint
GET Get api/V3/ArticleComment/Get?articleId={articleId}

Description: Get all comments associated with a knowledge article

POST Post api/V3/ArticleComment/Post

Description: Adds a new comment

PUT Patch api/V3/ArticleComment/Patch

Description: Updates existing comment

DELETE Delete api/V3/ArticleComment/Delete?commentId={commentId}

Description: Delete specified knowledge article comment.

DELETE Archive api/V3/ArticleComment/Archive?articleId={articleId}

Description: Archive all user's comments on the specified html knowledge article.

ServiceCatalog

End points to retrieve the service catalog and offerings.

Type Name Endpoint
GET GetServiceCatalog api/V3/ServiceCatalog/GetServiceCatalog?userId={userId}&isScoped={isScoped}

Description: Returns the service catalog for a specified user.

GET GetByRequestOfferingId api/V3/ServiceCatalog/GetByRequestOfferingId?requestOfferingId={requestOfferingId}

Description: Returns the request offering specified.

GET GetByServiceOfferingId api/V3/ServiceCatalog/GetByServiceOfferingId?serviceOfferingId={serviceOfferingId}

Description: Returns the service offering specified.

POST MarkFavorite api/V3/ServiceCatalog/MarkFavorite?requestOfferingId={requestOfferingId}&userId={userId}

Description: Marks the offering as a user favorite.

GET GetRequestOffering api/V3/ServiceCatalog/GetRequestOffering?requestOfferingId={requestOfferingId}&serviceOfferingId={serviceOfferingId}&userId={userId}&isScoped={isScoped}

Description: Returns the specified request offering.

GET GetTopRequestOffering api/V3/ServiceCatalog/GetTopRequestOffering?userId={userId}&returnAmount={returnAmount}&isScoped={isScoped}

Description: Returns the top request offerings based on parameters specified.

GET GetFavoriteRequestOffering api/V3/ServiceCatalog/GetFavoriteRequestOffering?userId={userId}&returnAmount={returnAmount}&isScoped={isScoped}&skipCount={skipCount}&takeCount={takeCount}

Description: Returns the user's favorite request offerings.

Description: Search the service catalog by type of RO and text.

Config

No Documentation For Controller Yet

Type Name Endpoint
GET GetAffectedItemsList api/V3/Config/GetAffectedItemsList?itemFilter={itemFilter}

Description: Returns a list of the first 50 Configuration Items using a filter.

GET GetAffectedItem api/V3/Config/GetAffectedItem?configItemObjectId={configItemObjectId}&userId={userId}&isUserScoped={isUserScoped}

Description: Returns the Configuration Item using User Id

GET GetPopulatedConfigClasses api/V3/Config/GetPopulatedConfigClasses

Description: Returns all Config Item classes that have data.

GET GetConfigItemsByClass api/V3/Config/GetConfigItemsByClass?userId={userId}&isUserScoped={isUserScoped}&searchFilter={searchFilter}&objectClassId={objectClassId}

Description: Returns a list of Configuration Items that have a Class Id in the provided list.

GET GetConfigItemsByAbstractClass api/V3/Config/GetConfigItemsByAbstractClass?userId={userId}&isUserScoped={isUserScoped}&searchFilter={searchFilter}&objectClassId={objectClassId}

Description: Returns a list of Configuration Items that have the specified Class Id or any of the derived classes of the Class Id specified.

Announcement

End points to retrieve and manage announcements.

Type Name Endpoint
GET GetAllAnnouncements api/V3/Announcement/GetAllAnnouncements?languageCode={languageCode}

Description: Returns all announcements for specified language code.

GET GetUserAnnouncements api/V3/Announcement/GetUserAnnouncements?userId={userId}&languageCode={languageCode}

Description: Get all announcements by user and language.

GET GetAnnouncement api/V3/Announcement/GetAnnouncement?announcementId={announcementId}&languageCode={languageCode}

Description: Get specific announcement by Id.

DELETE DeleteAnnouncement api/V3/Announcement/DeleteAnnouncement?announcementId={announcementId}

Description: Delete specified announcement.

POST UpdateAnnouncement api/V3/Announcement/UpdateAnnouncement

Description: Updates or Add announcement.

Settings

End points to retrieve and update console settings.

Type Name Endpoint
GET GetAllSettings api/V3/Settings/GetAllSettings

Description: Gets all settings including all tenants.

GET GetAllSettings api/V3/Settings/GetAllSettings?tenantId={tenantId}

Description: Gets all settings by tenant.

GET GetSetting api/V3/Settings/GetSetting?settingKey={settingKey}&tenantId={tenantId}

Description: Gets the specified setting.

POST SetSetting api/V3/Settings/SetSetting

Description: Updates or adds a setting.

User

Endpoints to retrieve user objects.

Type Name Endpoint
GET GetSupportGroupUsers api/V3/User/GetSupportGroupUsers?id={id}

Description: Returns a list of members of a support group enumeration.

GET GetUsersGroups api/V3/User/GetUsersGroups?id={id}

Description: Returns a list of the users's groups

GET GetUsersSupportGroupEnumerations api/V3/User/GetUsersSupportGroupEnumerations?id={id}

Description: Returns a list of Service Request Support Group Enumerations where the user is a member.

GET GetUsersTierQueueEnumerations api/V3/User/GetUsersTierQueueEnumerations?id={id}

Description: Returns a list of Incident Tier Queue Enumerations where the user is a member.

GET GetUserRelatedInfoByUserId api/V3/User/GetUserRelatedInfoByUserId?userId={userId}

Description: Returns user related information using the User Id

GET GetUserRelatedInfoBySIPAddress api/V3/User/GetUserRelatedInfoBySIPAddress?sipAddress={sipAddress}

Description: Returns user related information using the SIPAddress

GET GetUserList api/V3/User/GetUserList?userFilter={userFilter}&filterByAnalyst={filterByAnalyst}&groupsOnly={groupsOnly}&maxNumberOfResults={maxNumberOfResults}&fetchAll={fetchAll}

Description: Returns a list of users with minimal properties.

GET GetUserListWithEmail api/V3/User/GetUserListWithEmail?userFilter={userFilter}&filterByAnalyst={filterByAnalyst}&groupsOnly={groupsOnly}&maxNumberOfResults={maxNumberOfResults}&fetchAll={fetchAll}

Description: Returns a list of users with minimal properties and requires email to be not null.

GET GetUserListByFilteredDomain api/V3/User/GetUserListByFilteredDomain?userFilter={userFilter}&filterByAnalyst={filterByAnalyst}&groupsOnly={groupsOnly}&maxNumberOfResults={maxNumberOfResults}

Description: Returns a list of users with minimal properties filtered by domain.

GET GetAnalystResults api/V3/User/GetAnalystResults

Description: Returns a list of all Analysts

POST IsUserAuthorizedAsync api/V3/User/IsUserAuthorizedAsync?userName={userName}&domain={domain}

Description: Checks if the user is authorized to use the portal if so a ConsoleUser object is returned.

POST IsUserAuthorized api/V3/User/IsUserAuthorized?userName={userName}&domain={domain}

Description: Checks if the user is authorized to use the portal if so a ConsoleUser object is returned.

GET GetConsoleGroups api/V3/User/GetConsoleGroups

Description: Returns a list of all domain groups.

WorkItem

Endpoints to retrieve WorkItem objects.

Type Name Endpoint
GET GetGridWorkItemsByUser api/V3/WorkItem/GetGridWorkItemsByUser?userId={userId}&isScoped={isScoped}&showActivities={showActivities}&showInactiveItems={showInactiveItems}

Description: Returns Grid Work Items By User

GET GetGridWorkItemsMyGroups api/V3/WorkItem/GetGridWorkItemsMyGroups?userId={userId}&isScoped={isScoped}&showActivities={showActivities}&showInactiveItems={showInactiveItems}

Description: Returns Grid Work Items for User Groups

GET GetGridWorkItemsMyClosedRequests api/V3/WorkItem/GetGridWorkItemsMyClosedRequests?userId={userId}&maxCount={maxCount}

Description: Returns Closed Grid Work Items for User

GET GetGridWorkItemsMyRequests api/V3/WorkItem/GetGridWorkItemsMyRequests?userId={userId}&showInactiveItems={showInactiveItems}

Description: Returns Work Items Requested By User

GET GetGridWorkItemsAll api/V3/WorkItem/GetGridWorkItemsAll?userId={userId}&isScoped={isScoped}&showActivities={showActivities}&showInactiveItems={showInactiveItems}

Description: Returns All Work Items By User

GET GetMyTeamRequest api/V3/WorkItem/GetMyTeamRequest?userId={userId}&showInactiveItems={showInactiveItems}&isScoped={isScoped}

Description: Returns Work Items Requested By Users's Team

POST BulkEditWorkItems api/V3/WorkItem/BulkEditWorkItems

Description: Updates Work Items specified in the ItemIds list to the values set in the 'EditedFields' of the BulkEditedWorkItemModel. Currently only supports properties on the seed object. Supported property types are as follows: enum, string, date, int, double, bool, singlecardinalityobject (i.e. AffectedUser), multiplecardinalityobject (i.e. Action Log). The EditedValue for a property with type of singlecardinality will be equal to GUID of the specified object. The EditedValue for a property with type of multiplecardinalityobject will be the object in json format.

POST GetChildWorkItems api/V3/WorkItem/GetChildWorkItems

Description: Retrieves the child workitem Guids for any requested parent Base Ids

GET GetWatchlistByWorkItemId api/V3/WorkItem/GetWatchlistByWorkItemId?workitemId={workitemId}

Description: Returns users for a specified workitem

GET GetWatchListByUserId api/V3/WorkItem/GetWatchListByUserId?userId={userId}

Description: Returns all user's watched items

POST AddToWatchlist api/V3/WorkItem/AddToWatchlist?workitemId={workitemId}&userId={userId}

Description: Add an item to the watchlist table

DELETE DeleteFromWatchlist api/V3/WorkItem/DeleteFromWatchlist?workitemId={workitemId}&userId={userId}

Description: Remove an item from the watchlist

POST AddUsersToWatchlist api/V3/WorkItem/AddUsersToWatchlist?workitemId={workitemId}

Description: Add multiple users to the watchlist

DELETE RemoveUsersFromWatchlist api/V3/WorkItem/RemoveUsersFromWatchlist?workitemId={workitemId}

Description: Remove multiple users from the watchlist

GET GetGridWorkItemsMyActivities api/V3/WorkItem/GetGridWorkItemsMyActivities?userId={userId}&isScoped={isScoped}&showInActives={showInActives}

Description: Returns list of activities assigned to the specified user

GET GetGridWorkItemsMyApprovals api/V3/WorkItem/GetGridWorkItemsMyApprovals?userId={userId}&isScoped={isScoped}&showInActives={showInActives}

Description: Returns list of uncompleted review activities assigned to the specified user

GET GetGridWorkItemsMyManualActivities api/V3/WorkItem/GetGridWorkItemsMyManualActivities?userId={userId}&isScoped={isScoped}&showInActives={showInActives}

Description: Returns list of manual activities assigned to the specified user

GET GetGridIncidentsByUser api/V3/WorkItem/GetGridIncidentsByUser?userId={userId}&isScoped={isScoped}&showActivities={showActivities}&showInactiveItems={showInactiveItems}

Description: Returns list incidents assigned to the specified user

GET GetGridWorkItemsAllIncident api/V3/WorkItem/GetGridWorkItemsAllIncident?userId={userId}&isScoped={isScoped}&showActivities={showActivities}&showInactiveItems={showInactiveItems}

Description: Returns list of all incident work item

Template

Endpoints for retrieving template objects.

Type Name Endpoint
GET GetTemplates api/V3/Template/GetTemplates?classId={classId}

Description: Returns templates by class Id

GET GetNotificationTemplatesAsync api/V3/Template/GetNotificationTemplatesAsync?classId={classId}

Description: Returns notification templates by class id.

GET GetNotificationTemplatesWithPrefix api/V3/Template/GetNotificationTemplatesWithPrefix?classId={classId}&prefix={prefix}

Description: Returns notification templates by class Id with the Display name starting with the Prefix indicated.

GET GetHardwareAssetNotificationTemplates api/V3/Template/GetHardwareAssetNotificationTemplates

Description: Returns hardware asset notification templates.

GET GetAllClasses api/V3/Template/GetAllClasses

Description: Returns templates from all classes.

Enum

Endpoints to retrieve enumerations.

Type Name Endpoint
GET GetList api/V3/Enum/GetList?id={id}&itemFilter={itemFilter}&Flatten={Flatten}&itemFilterIds={itemFilterIds}

Description: GetList retrieves the children of an enumeration class id that is a parent. Returns items that are only one level down from the root id that is sent.

GET GetList api/V3/Enum/GetList?id={id}&parentId={parentId}&itemFilter={itemFilter}&Flatten={Flatten}

Description: GetList retrieves the children of an enumeration class id that is a child. Used for lazy loading of the enum picker. Returns items that are only one level down from the root id that is sent.

GET GetListForRequestOffering api/V3/Enum/GetListForRequestOffering?parentId={parentId}&itemFilter={itemFilter}&Flatten={Flatten}&id={id}

Description: This method is used to get enumerations for an older version of the enumeration treeview.

GET GetFlatList api/V3/Enum/GetFlatList?id={id}&itemFilter={itemFilter}&includeParents={includeParents}&itemFilterIds={itemFilterIds}

Description: GetFlatList retrieves a flattened list of enumeration children. This is used for client side filtering of the enum picker autocomplete. This will only return the first 250 that match the filter. For example: A, A\B, A\B\C

GET GetEnumDisplayName api/V3/Enum/GetEnumDisplayName?id={id}

Description: Retrieves the displayname for an enumeration id in this format: Parent DisplayName\Child DisplayName

GET GetEnumFlatDisplayName api/V3/Enum/GetEnumFlatDisplayName?TopLevelId={TopLevelId}&Id={Id}

Description: Retrieves the flattened displayname for an enumeration id.

GET GetMappedSupportGroupsList api/V3/Enum/GetMappedSupportGroupsList?id={id}

Description: Retrieves a list of enumerations/support groups that are mapped

ArticleRating

endpoint to retrieve, update, and delete Knowledge Article ratings

Type Name Endpoint
GET Get api/V3/ArticleRating/Get?articleId={articleId}&userId={userId}

Description: Get user rating details of the specified knowledge article.

POST Post api/V3/ArticleRating/Post

Description: Add a new user rating on the specified knowledge article.

PUT Put api/V3/ArticleRating/Put

Description: Update user's rating of the specified knowledge article.

Projection

Endpoints to retrieve and update projection objects.

Type Name Endpoint
POST Commit api/V3/Projection/Commit?fileAttachmentPath={fileAttachmentPath}&runConcurrencyCheck={runConcurrencyCheck}

Description: Updates a workitem projection in order to create a new workitem ensure that the LastModified property is set to : "LastModified": "0001-01-01T00:00:00.000Z"

GET CreateProjectionByTemplate api/V3/Projection/CreateProjectionByTemplate?id={id}&createdById={createdById}

Description: Creates a projection using template id.

GET GetProjectionByTemplateWithParameter api/V3/Projection/GetProjectionByTemplateWithParameter?id={id}&createdById={createdById}

Description: Creates a projection using template id and set default property value.

POST GetProjectionByCriteria api/V3/Projection/GetProjectionByCriteria

Description: Performs a search using the class id and provided criteria filters. For examples of criteria see the ApiExamples.docx.

GET GetProjection api/V3/Projection/GetProjection?id={id}&typeProjectionId={typeProjectionId}

Description: Returns json format of an object based on the provided type projection id.

GET GetBase64String api/V3/Projection/GetBase64String?BaseId={BaseId}&PropertyName={PropertyName}

Description: No documentation available.

GET GetParentWorkItemSettings api/V3/Projection/GetParentWorkItemSettings

Description: Returns the SCSM settings for Work Items

KnowledgeBase

Endpoint to retrieve and update knowledge base articles.

Type Name Endpoint
GET GetKnowledgeArticlesByOfferingId api/V3/KnowledgeBase/GetKnowledgeArticlesByOfferingId?offeringId={offeringId}

Description: (Deprecated) Returns a list of knowledge articles related to an offering.

POST SearchArticles api/V3/KnowledgeBase/SearchArticles?searchfilter={searchfilter}&userId={userId}

Description: (Deprecated) Returns a list of RTF articles using search filters provided.

GET GetKnowledgeArticle api/V3/KnowledgeBase/GetKnowledgeArticle?articleId={articleId}

Description: (Deprecated) Returns specified RTF knowledge article.

GET GetHTMLKnowledgeArticle api/V3/KnowledgeBase/GetHTMLKnowledgeArticle?knowledgeArticleId={knowledgeArticleId}

Description: (Deprecated) Returns the specified html knowledge article.

GET GetTopHTMLKnowledgeArticleList api/V3/KnowledgeBase/GetTopHTMLKnowledgeArticleList?userId={userId}

Description: (Deprecated) Returns the top 10 most popular html knowledge articles.

GET GetTopHTMLKnowledgeArticleList api/V3/KnowledgeBase/GetTopHTMLKnowledgeArticleList?count={count}&userId={userId}

Description: (Deprecated) Returns the specified count of the most popular html knowledge articles.

GET GetHTMLArticlesFullTextSearch api/V3/KnowledgeBase/GetHTMLArticlesFullTextSearch?userId={userId}&searchValue={searchValue}&isManager={isManager}&userLanguageCode={userLanguageCode}

Description: (Deprecated) Returns html knowledge articles that match the search value.

GET GetHTMLArticles api/V3/KnowledgeBase/GetHTMLArticles?userId={userId}&createdDate={createdDate}&lastModifiedDate={lastModifiedDate}&title={title}&languageName={languageName}&createdDateAfter={createdDateAfter}&lastModifiedDateAfter={lastModifiedDateAfter}&articleId={articleId}&statusId={statusId}&typeId={typeId}&categoryId={categoryId}&ownerId={ownerId}&lastModifiedById={lastModifiedById}&languageId={languageId}

Description: (Deprecated) Returns html knowledge articles matching the specified criteria.

POST AddOrUpdateHTMLKnowledge api/V3/KnowledgeBase/AddOrUpdateHTMLKnowledge

Description: (Deprecated) Add or updates an HTML Knowledge article.

POST AddOrUpdateHTMLKnowledgeApi api/V3/KnowledgeBase/AddOrUpdateHTMLKnowledgeApi

Description: (Deprecated) Add or updates an HTML Knowledge article via the API

DELETE DeleteHtmlKnowledge api/V3/KnowledgeBase/DeleteHtmlKnowledge?articleId={articleId}

Description: (Deprecated) Deletes the specified html knowledge article.

Article

endpoint to retrieve Knowledge Article

Type Name Endpoint
GET Get api/V3/Article/Get

Description: Gets a list of knowledge articles

GET Get api/V3/Article/Get?articleId={articleId}

Description: Gets knowledge article details by article id

POST GetForGrid api/V3/Article/GetForGrid

Description: Gets a list of knowledge articles for a grid datasource

PATCH Patch api/V3/Article/Patch

Description: Updates a batch of article's popularity index only.

PATCH Patch api/V3/Article/Patch?articleId={articleId}

Description: Archives the knowledge article

POST RelateToWorkItem api/V3/Article/RelateToWorkItem?workItemId={workItemId}

Description: Relates a work item to one or more knowledge articles

GET GetTopArticlesByRating api/V3/Article/GetTopArticlesByRating?count={count}

Description: Returns the highest rated html knowledge articles.

GET GetTopArticlesByCreatedDate api/V3/Article/GetTopArticlesByCreatedDate?count={count}

Description: Returns the recently added html knowledge articles.

GET GetTopArticlesByViewCount api/V3/Article/GetTopArticlesByViewCount?count={count}

Description: Returns the most viewed html knowledge articles.

GET GetTopArticlesByPopularity api/V3/Article/GetTopArticlesByPopularity?count={count}

Description: Returns the most popular html knowledge articles.

Description: Gets a list of knowledge articles based on the search criteria (Only the ArticleId, Title, and Abstract fields will be populated as this endpoint is used to populate a grid)

GET FullTextSearch api/V3/Article/FullTextSearch?searchValue={searchValue}

Description: Gets a list of knowledge articles using full text search

POST GetArticlesRelatedToWorkItem api/V3/Article/GetArticlesRelatedToWorkItem?workItemId={workItemId}

Description: Gets a list of knowledge articles related to the specified work item

POST GetArticlesRelatedToAsset api/V3/Article/GetArticlesRelatedToAsset?assetId={assetId}

Description: Gets a list of knowledge articles related to the specified asset

POST RemoveArticlesRelatedToWorkItem api/V3/Article/RemoveArticlesRelatedToWorkItem?workItemId={workItemId}

Description: Remove work item related articles

ArticleList

Endpoint specific for lists of articles, filtered or grouped.

Type Name Endpoint
GET Get api/V3/ArticleList/Get?categoryId={categoryId}&skipCount={skipCount}&takeCount={takeCount}

Description: Gets a list of articles grouped by the category passed as param. Also includes sub category articles.

GET Get api/V3/ArticleList/Get?searchText={searchText}&selectedCategories[0]={selectedCategories[0]}&selectedCategories[1]={selectedCategories[1]}&selectedTypes[0]={selectedTypes[0]}&selectedTypes[1]={selectedTypes[1]}&skipCount={skipCount}&takeCount={takeCount}

Description: Gets a list of knowledge articles filtered by text, categories, and types.

Dashboard

Endpoints used to execute sql dashboard queries

Type Name Endpoint
GET GetDashboardDataById api/V3/Dashboard/GetDashboardDataById?queryId={queryId}

Description: A GET method that executes the provided query id and returns the result in json format

Authorization

Authorization Token for Web API use outside of the portal

Type Name Endpoint
POST GetToken api/V3/Authorization/GetToken?UserName={UserName}&Password={Password}&LanguageCode={LanguageCode}

Description: Create an access token

ArticleCategory

Endpoints for interacting with Knowledge Article Categories

Type Name Endpoint
GET Get api/V3/ArticleCategory/Get?flatList={flatList}

Description: Gets all Knowledge Article Categories.

GET Get api/V3/ArticleCategory/Get?categoryId={categoryId}

Description: Returns breadcrumb heirarchy for article category