Virima API Specification - KnowledgeManagementService Services

The requests documented in this section are directed to KnowledgeManagementService resources, which represent .

Contents

1 addKnowledge POST Interface
2 editKnowledge POST Interface
3 getDefaultModel GET Interface
4 getKnowledge GET Interface
5 getAllKnowledgeTemplates GET Interface
6 getLatestKnowledges GET Interface
7 makeKnowledgePublic GET Interface
8 requestChange GET Interface
9 addArticleRating POST Interface
10 searchDuplicates POST Interface
11 editKnowledgeSubmission POST Interface
12 getAllSuggestions GET Interface
13 getAllSubscribers GET Interface
14 editSubscription GET Interface
15 knowledgeTransfer POST Interface
16 getTopics GET Interface
17 getLegislationTypes GET Interface
18 searchThreshold GET Interface
19 resultThreshold GET Interface
20 getSearchThreshold GET Interface
21 getResultThreshold GET Interface
22 setThreshold GET Interface
23 getThreshold GET Interface
24 setRatingThreshold GET Interface
25 getRatingThreshold GET Interface
26 addFAQ POST Interface
27 markArticleAsImportant POST Interface
28 getImportantUsers GET Interface
29 getTrendingKnowledges GET Interface

addKnowledge POST Interface

Method: POST

Relative URL: knowledge-mgmt/add

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
editValuesArray	EditValuesArray

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDKNOWLEDGE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "entityId":?,
   "customerId":"?",
   "mspClientId":"?",
   "module":"?",
   "workflowId":?,
   "templateName":"?",
   "templateId":"?",
   "selectedTemplate":"?",
   "accessRoles":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "isTemplate":?,
   "isMultiple":?,
   "archive":?,
   "currentAssigneeRole":"?",
   "isIncident":?,
   "moving":?,
   "createdFromTask":?,
   "checkSession":?,
   "loggedInUserId":?,
   "createdFromEntity":"?",
   "createdFromEntityId":?,
   "privatePropertyList":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "privatePropertyRoleList":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "timescale":[
      {
         "responseTime":"?",
         "resolutionTime":"?",
         "firstLevelSupport":"?",
         "secondLevelSupport":"?",
         "thirdLevelSupport":"?",
         "timescaleNotifications":[
            {
               "customTimeScale":?,
               "action":"?",
               "timing":"?",
               "minutes":"?",
               "module":"?",
            }         ]
      }   ],
   "editValues":[
      {
         "property":"?",
         "value":"?",
         "blockId":"?"
      }   ],
   "totalTimeSpent":?,
   "userEmailId":"?",
   "fromSACM":?,
   "copyId":"?",
   "isCopiedByPrimaryCustomer":?,
   "mspIncidentId":"?",
   "idList":[
      {
         "flag":?
      }   ],
   "isImport":?,
   "isBulkUpdate":?
}

Example Response:

{
   "id":591896003,
   "response":"?"
}

editKnowledge POST Interface

Method: POST

Relative URL: knowledge-mgmt/edit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
editValuesArray	EditValuesArray

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITKNOWLEDGE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "entityId":?,
   "customerId":"?",
   "mspClientId":"?",
   "module":"?",
   "workflowId":?,
   "templateName":"?",
   "templateId":"?",
   "selectedTemplate":"?",
   "accessRoles":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "isTemplate":?,
   "isMultiple":?,
   "archive":?,
   "currentAssigneeRole":"?",
   "isIncident":?,
   "moving":?,
   "createdFromTask":?,
   "checkSession":?,
   "loggedInUserId":?,
   "createdFromEntity":"?",
   "createdFromEntityId":?,
   "privatePropertyList":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "privatePropertyRoleList":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "timescale":[
      {
         "responseTime":"?",
         "resolutionTime":"?",
         "firstLevelSupport":"?",
         "secondLevelSupport":"?",
         "thirdLevelSupport":"?",
         "timescaleNotifications":[
            {
               "customTimeScale":?,
               "action":"?",
               "timing":"?",
               "minutes":"?",
               "module":"?",
            }         ]
      }   ],
   "editValues":[
      {
         "property":"?",
         "value":"?",
         "blockId":"?"
      }   ],
   "totalTimeSpent":?,
   "userEmailId":"?",
   "fromSACM":?,
   "copyId":"?",
   "isCopiedByPrimaryCustomer":?,
   "mspIncidentId":"?",
   "idList":[
      {
         "flag":?
      }   ],
   "isImport":?,
   "isBulkUpdate":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getDefaultModel GET Interface

Method: GET

Relative URL: knowledge-mgmt/get-default-model

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getKnowledge GET Interface

Method: GET

Relative URL: knowledge-mgmt/get-knowledge/knowledge-id/template-id/is-article

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getAllKnowledgeTemplates GET Interface

Method: GET

Relative URL: knowledge-mgmt/get-all-knowledge-templates

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getLatestKnowledges GET Interface

Method: GET

Relative URL: knowledge-mgmt/get-latest-knowledges/search-key

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

{
   "id":1751473797,
   "response":"?"
}

makeKnowledgePublic GET Interface

Method: GET

Relative URL: knowledge-mgmt/make-public/knowledge-id/is-public

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

requestChange GET Interface

Method: GET

Relative URL: knowledge-mgmt/request-change/knowledge-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

addArticleRating POST Interface

Method: POST

Relative URL: knowledge-mgmt/add-artcle-rating

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
rating	ArticleRating

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDARTICLERATING 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "createdOn":?,
   "flagged":?,
   "helpful":?,
   "rating":?,
   "knowledge": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "feedback":"?",
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }
}

Example Response:

{
   "id":108440851,
   "response":"?"
}

searchDuplicates POST Interface

Description: Service to get latest changes, requests, incidents, problems and known errors created based on the conditions specified.

Method: POST

Relative URL: knowledge-mgmt/search-duplicates

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
input	SearchPojo

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

SEARCHDUPLICATES 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "title":"?",
   "reporter":"?",
   "category":"?",
   "associatedCIs":"?",
   "module":"?",
   "topic":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

editKnowledgeSubmission POST Interface

Description: Service to edit knowledge submission

Method: POST

Relative URL: knowledge-mgmt/edit-knowledge-submission

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
knowledge	KnowledgeSubmission

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITKNOWLEDGESUBMISSION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "title":"?",
   "createdOn":?,
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "lastModifiedOn":?,
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "details":?,
   "state":"?",
   "closureNotes":"?",
   "topic":"?",
   "category":"?",
   "articleType":"?",
   "groupAssignee": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "assignee": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "submittedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "articleLink":"?",
   "articleAttachment": {
         "fileId":?,
         "fileName":"?"
      },
   "article":"?",
   "legislationType":"?",
   "reasonForInformation":"?",
   "validTo":?,
   "uniqueId":"?",
   "archive":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getAllSuggestions GET Interface

Method: GET

Relative URL: knowledge-mgmt/get-suggestions/entity-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
comments	ArrayOfComment

Example Request:

Example Response:

{
   "id":237511675,
   "comments":[
      {
         "id":2147483647,
         "commentId":?,
         "userName":"?",
         "entityId":?,
         "entityValue":"?",
         "commentValue":"?",
         "date":?,
         "addedBy":"?",
         "attachmentsList":"?"
      }   ]
}

getAllSubscribers GET Interface

Method: GET

Relative URL: knowledge-mgmt/get-subscribers/entity-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

editSubscription GET Interface

Description: Service to subscibe or unsubscribe logged in user

Method: GET

Relative URL: knowledge-mgmt/subscribe/entity-id/subscribe

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

knowledgeTransfer POST Interface

Description: Service to subscribe or unsubscribe multiple users

Method: POST

Relative URL: knowledge-mgmt/knowledge-transfer/entity-id/subscribe

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
users	RecordList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

KNOWLEDGETRANSFER 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "scanId":?,
   "workflowId":?,
   "fromSACM":?,
   "customerId":"?",
   "userId":"?",
   "startTime":"?",
   "idList":[
      {
         "flag":?
      }   ]
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getTopics GET Interface

Method: GET

Relative URL: knowledge-mgmt/get-topics

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getLegislationTypes GET Interface

Method: GET

Relative URL: knowledge-mgmt/get-legislation-types

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

searchThreshold GET Interface

Description: Service to add search term threshold

Method: GET

Relative URL: knowledge-mgmt/search-threshold/value

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

resultThreshold GET Interface

Description: Service to add search result threshold

Method: GET

Relative URL: knowledge-mgmt/result-threshold/value

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2118338382,
   "response":"?"
}

getSearchThreshold GET Interface

Description: Service to get search term threshold

Method: GET

Relative URL: knowledge-mgmt/get-search-threshold

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getResultThreshold GET Interface

Description: Service to get search result threshold

Method: GET

Relative URL: knowledge-mgmt/get-result-threshold

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

setThreshold GET Interface

Description: Service to add search term and result threshold

Method: GET

Relative URL: knowledge-mgmt/set-threshold/search-threshold/result-threshold

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getThreshold GET Interface

Description: Service to get search result and result threshold

Method: GET

Relative URL: knowledge-mgmt/get-threshold

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

setRatingThreshold GET Interface

Description: Service to add rating and helpful threshold

Method: GET

Relative URL: knowledge-mgmt/set-rating-threshold/rating-threshold/helpful-threshold

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":79563325,
   "response":"?"
}

getRatingThreshold GET Interface

Description: Service to get rating and helpful threshold

Method: GET

Relative URL: knowledge-mgmt/get-rating-threshold

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

addFAQ POST Interface

Description: Service to add FAQs.

Method: POST

Relative URL: knowledge-mgmt/add-faq

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
input	Response

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

ADDFAQ 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "response":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

markArticleAsImportant POST Interface

Description: Service to mark an article important to the logged in user

Method: POST

Relative URL: knowledge-mgmt/mark-as-important/entity-id/important

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
input	Response

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

MARKARTICLEASIMPORTANT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "response":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getImportantUsers GET Interface

Description: Service to get important users of an article

Method: GET

Relative URL: knowledge-mgmt/get-important-users/entity-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":388128568,
   "response":"?"
}

getTrendingKnowledges GET Interface

Description: Service to get important users of an article

Method: GET

Relative URL: knowledge-mgmt/get-trending-knowledges/from/to

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}