Entity API / logKnownError

Operation Information

Application Reference: com.hornbill.servicemanager
Scope: Entity - KnownErrors
Class: Entity
Required Privilege Level: user
Required Rights: Group B - createKnownErrors

Description

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.

Request Parameters

The logKnownError API takes the following input parameters. It is important to note that the parameters must satisfy the requirement of the input validation checks.

Name	Type	Required	Description
`summary`	`xs:string`	No	Summary of the known error
`description`	`xs:string`	No	Description of the known error.
`requestType`	`xs:string`	No	The type of request (Known Error).
`customerId`	`xs:string`	No	The customer Id (Co-worker / Contact). If the customer is a co-worker, the id will be their User ID. If the customer is a contact, the id will be the h_pk_id value of their record in the h_sys_contact table.
`customerType`	`xs:string`	No	The customer type (Co-worker / Contact). 0 for a co-worker, 1 for a contact.
`ownerId`	`xs:string`	No	The co-worker ID of the owner of the known error.
`teamId`	`xs:string`	No	The Id of the team assigned to the Request. This is the h_id value of the record in the h_sys_groups table for the assigned team.
`employeeAssignmentId`	`xs:string`	No	The Id of the employee assignment assigned to the Request.
`status`	`xs:string`	No	The status of the known error, i.e status.open or status.closed. When not supplied, the value "status.new" is considered.
`priorityId`	`xs:string`	No	The ID of the chosen priority for the known error.
`categoryId`	`xs:string`	No	The ID of the chosen category for the known error.
`categoryName`	`xs:string`	No	The Name of the category
`image`	`xs:string`	No	WebDAV path to an image (from email only).
`sourceType`	`xs:string`	No	The source from where the known error was raised (e.g. Email / Post).
`sourceId`	`xs:string`	No	The ID of the source object the known error was raised from (if Email:messageId, if Post:ActivityStreamID and ActivityID).
`assetId`	`xs:string`	No	The ID(s) of all assets to be associated to the known error.
`impact`	`xs:string`	No	The impact of the known error. E.g. High, Medium, Low.
`urgencyId`	`xs:string`	No	The ID of the request's Urgency level
`serviceId`	`xs:string`	No	The id of the selected service. This will be used to spawn a bpm process.
`questions`	`xs:string`	No	Questions that were answered during progressive capture
`resolutionDetails`	`xs:string`	No	Details of how the error condition was resolved.
`rootCause`	`xs:string`	No	The steps leading to the error that was observed.
`stepsToResolve`	`xs:string`	No	The resolution details of the known error if it is to be raised and resolved at the same time.
`fileName`	`xs:string`	No	The full path for the file(s) to be attached.
`siteId`	`xs:string`	No	ID of the site this request is affecting
`siteName`	`xs:string`	No	Name of the site this request is affecting
`catalogId`	`xs:string`	No	The Catalog Id the Request was raised against
`catalogName`	`xs:string`	No	The Catalog Name the Request was raised against
`externalRefNumber`	`xs:string`	No	This parameter is to be set with the External Reference Number of a Request.
`bpmName`	`xs:string`	No	The custom BPM Name when raising a request via a customised Service Catalog
`questionFieldMap`	`xs:string`	No	Question Field Map as JSON
`connectionMap`	`xs:string`	No	Connection Map as JSON
`connectionUpdateTimeline`	`xs:boolean`	No	Update timeline true/false
`connectionTimelineVisibility`	`xs:string`	No	Visibility level of timeline updates for added connections. Timeline update visibility defaults to Team if not provided.

Response Parameters

Name	Type	Description
`requestId`	`xs:string`	The id of the new known error.
`bpmProcessId`	`xs:string`	The id of the spawned BPM process for the new known error.
`exceptionName`	`xs:string`	The name / code of any exception thrown during the creation of the known error.
`exceptionDescription`	`xs:string`	A description of any exception thrown during the creation of the known error.
`summary`	`xs:string`	The provided summary of the known error.
`warnings`	`xs:string`	Any warnings that were encountered when logging the known error.

Code Examples

      curl -X POST 'https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager/KnownErrors' \
   -H 'Authorization: ESP-APIKEY yourHornbillAPIKey' \
   -H 'Content-Type: application/json' \
   -d '{"@service":"apps/com.hornbill.servicemanager/KnownErrors","@method":"logKnownError","params":{"summary":"xs:string","description":"xs:string","requestType":"xs:string","customerId":"xs:string","customerType":"xs:string","ownerId":"xs:string","teamId":"xs:string","employeeAssignmentId":"xs:string","status":"xs:string","priorityId":"xs:string","categoryId":"xs:string","categoryName":"xs:string","image":"xs:string","sourceType":"xs:string","sourceId":"xs:string","assetId":"xs:string","impact":"xs:string","urgencyId":"xs:string","serviceId":"xs:string","questions":"xs:string","resolutionDetails":"xs:string","rootCause":"xs:string","stepsToResolve":"xs:string","fileName":"xs:string","siteId":"xs:string","siteName":"xs:string","catalogId":"xs:string","catalogName":"xs:string","externalRefNumber":"xs:string","bpmName":"xs:string","questionFieldMap":"xs:string","connectionMap":"xs:string","connectionUpdateTimeline":false,"connectionTimelineVisibility":"xs:string"}}'

      package main
import (
    "fmt"
    apiLib "github.com/hornbill/goApiLib"
)
func main() {
	hornbillAPI := apiLib.NewXmlmcInstance("yourinstanceid")
	hornbillAPI.SetAPIKey("yourHornbillAPIKey")
	hornbillAPI.SetJSONResponse(true)
	hornbillAPI.SetParam("summary", "xs:string")
	hornbillAPI.SetParam("description", "xs:string")
	hornbillAPI.SetParam("requestType", "xs:string")
	hornbillAPI.SetParam("customerId", "xs:string")
	hornbillAPI.SetParam("customerType", "xs:string")
	hornbillAPI.SetParam("ownerId", "xs:string")
	hornbillAPI.SetParam("teamId", "xs:string")
	hornbillAPI.SetParam("employeeAssignmentId", "xs:string")
	hornbillAPI.SetParam("status", "xs:string")
	hornbillAPI.SetParam("priorityId", "xs:string")
	hornbillAPI.SetParam("categoryId", "xs:string")
	hornbillAPI.SetParam("categoryName", "xs:string")
	hornbillAPI.SetParam("image", "xs:string")
	hornbillAPI.SetParam("sourceType", "xs:string")
	hornbillAPI.SetParam("sourceId", "xs:string")
	hornbillAPI.SetParam("assetId", "xs:string")
	hornbillAPI.SetParam("impact", "xs:string")
	hornbillAPI.SetParam("urgencyId", "xs:string")
	hornbillAPI.SetParam("serviceId", "xs:string")
	hornbillAPI.SetParam("questions", "xs:string")
	hornbillAPI.SetParam("resolutionDetails", "xs:string")
	hornbillAPI.SetParam("rootCause", "xs:string")
	hornbillAPI.SetParam("stepsToResolve", "xs:string")
	hornbillAPI.SetParam("fileName", "xs:string")
	hornbillAPI.SetParam("siteId", "xs:string")
	hornbillAPI.SetParam("siteName", "xs:string")
	hornbillAPI.SetParam("catalogId", "xs:string")
	hornbillAPI.SetParam("catalogName", "xs:string")
	hornbillAPI.SetParam("externalRefNumber", "xs:string")
	hornbillAPI.SetParam("bpmName", "xs:string")
	hornbillAPI.SetParam("questionFieldMap", "xs:string")
	hornbillAPI.SetParam("connectionMap", "xs:string")
	hornbillAPI.SetParam("connectionUpdateTimeline", "xs:boolean")
	hornbillAPI.SetParam("connectionTimelineVisibility", "xs:string")
	responseBody, apiError := hornbillAPI.Invoke("apps/com.hornbill.servicemanager/KnownErrors", "logKnownError")
	if apiError != nil {
		fmt.Println(apiError)
		return
	}
	fmt.Println(responseBody)
}

      const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager/KnownErrors";
const payload = {
  "@service": "apps/com.hornbill.servicemanager/KnownErrors",
  "@method": "logKnownError",
  "params": {
    "summary": "xs:string",
    "description": "xs:string",
    "requestType": "xs:string",
    "customerId": "xs:string",
    "customerType": "xs:string",
    "ownerId": "xs:string",
    "teamId": "xs:string",
    "employeeAssignmentId": "xs:string",
    "status": "xs:string",
    "priorityId": "xs:string",
    "categoryId": "xs:string",
    "categoryName": "xs:string",
    "image": "xs:string",
    "sourceType": "xs:string",
    "sourceId": "xs:string",
    "assetId": "xs:string",
    "impact": "xs:string",
    "urgencyId": "xs:string",
    "serviceId": "xs:string",
    "questions": "xs:string",
    "resolutionDetails": "xs:string",
    "rootCause": "xs:string",
    "stepsToResolve": "xs:string",
    "fileName": "xs:string",
    "siteId": "xs:string",
    "siteName": "xs:string",
    "catalogId": "xs:string",
    "catalogName": "xs:string",
    "externalRefNumber": "xs:string",
    "bpmName": "xs:string",
    "questionFieldMap": "xs:string",
    "connectionMap": "xs:string",
    "connectionUpdateTimeline": false,
    "connectionTimelineVisibility": "xs:string"
  }
};
fetch(endpoint, {
  method: 'POST',
  headers: {
    "Authorization": "ESP-APIKEY yourHornbillAPIKey"
  },
  body: JSON.stringify(payload)
}).then(res => res.json())
  .then(res => console.log(res));

      const axios = require('axios');
const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager/KnownErrors";
const payload = {
  "@service": "apps/com.hornbill.servicemanager/KnownErrors",
  "@method": "logKnownError",
  "params": {
    "summary": "xs:string",
    "description": "xs:string",
    "requestType": "xs:string",
    "customerId": "xs:string",
    "customerType": "xs:string",
    "ownerId": "xs:string",
    "teamId": "xs:string",
    "employeeAssignmentId": "xs:string",
    "status": "xs:string",
    "priorityId": "xs:string",
    "categoryId": "xs:string",
    "categoryName": "xs:string",
    "image": "xs:string",
    "sourceType": "xs:string",
    "sourceId": "xs:string",
    "assetId": "xs:string",
    "impact": "xs:string",
    "urgencyId": "xs:string",
    "serviceId": "xs:string",
    "questions": "xs:string",
    "resolutionDetails": "xs:string",
    "rootCause": "xs:string",
    "stepsToResolve": "xs:string",
    "fileName": "xs:string",
    "siteId": "xs:string",
    "siteName": "xs:string",
    "catalogId": "xs:string",
    "catalogName": "xs:string",
    "externalRefNumber": "xs:string",
    "bpmName": "xs:string",
    "questionFieldMap": "xs:string",
    "connectionMap": "xs:string",
    "connectionUpdateTimeline": false,
    "connectionTimelineVisibility": "xs:string"
  }
};
const axiosConfig = {
  headers: {
    "Authorization": "ESP-APIKEY yourHornbillAPIKey"
  }
};
axios.post(endpoint, payload, axiosConfig)
.then((res) => {
    console.log("RESPONSE RECEIVED: ", res);
})
.catch((err) => {
    console.log("AXIOS ERROR: ", err);
})

      $endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager/KnownErrors";
$payload = (object) [
    '@service' => 'apps/com.hornbill.servicemanager/KnownErrors',
    '@method' => 'logKnownError',
    'params' => (object) [
        'summary' => 'xs:string',
        'description' => 'xs:string',
        'requestType' => 'xs:string',
        'customerId' => 'xs:string',
        'customerType' => 'xs:string',
        'ownerId' => 'xs:string',
        'teamId' => 'xs:string',
        'employeeAssignmentId' => 'xs:string',
        'status' => 'xs:string',
        'priorityId' => 'xs:string',
        'categoryId' => 'xs:string',
        'categoryName' => 'xs:string',
        'image' => 'xs:string',
        'sourceType' => 'xs:string',
        'sourceId' => 'xs:string',
        'assetId' => 'xs:string',
        'impact' => 'xs:string',
        'urgencyId' => 'xs:string',
        'serviceId' => 'xs:string',
        'questions' => 'xs:string',
        'resolutionDetails' => 'xs:string',
        'rootCause' => 'xs:string',
        'stepsToResolve' => 'xs:string',
        'fileName' => 'xs:string',
        'siteId' => 'xs:string',
        'siteName' => 'xs:string',
        'catalogId' => 'xs:string',
        'catalogName' => 'xs:string',
        'externalRefNumber' => 'xs:string',
        'bpmName' => 'xs:string',
        'questionFieldMap' => 'xs:string',
        'connectionMap' => 'xs:string',
        'connectionUpdateTimeline' => 'xs:boolean',
        'connectionTimelineVisibility' => 'xs:string',
    ]
];
$headers = [
    'Authorization: ESP-APIKEY yourHornbillAPIKey',
    'Content-Type: application/json'
];
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_URL, $endpoint);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($payload));
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
$resp = curl_exec($curl);
curl_close($curl);
echo $resp;

      $Endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager/KnownErrors"
$Body = @{
	"@service" = "apps/com.hornbill.servicemanager/KnownErrors"
	"@method" = "logKnownError"
	params = @{
		summary = "xs:string"
		description = "xs:string"
		requestType = "xs:string"
		customerId = "xs:string"
		customerType = "xs:string"
		ownerId = "xs:string"
		teamId = "xs:string"
		employeeAssignmentId = "xs:string"
		status = "xs:string"
		priorityId = "xs:string"
		categoryId = "xs:string"
		categoryName = "xs:string"
		image = "xs:string"
		sourceType = "xs:string"
		sourceId = "xs:string"
		assetId = "xs:string"
		impact = "xs:string"
		urgencyId = "xs:string"
		serviceId = "xs:string"
		questions = "xs:string"
		resolutionDetails = "xs:string"
		rootCause = "xs:string"
		stepsToResolve = "xs:string"
		fileName = "xs:string"
		siteId = "xs:string"
		siteName = "xs:string"
		catalogId = "xs:string"
		catalogName = "xs:string"
		externalRefNumber = "xs:string"
		bpmName = "xs:string"
		questionFieldMap = "xs:string"
		connectionMap = "xs:string"
		connectionUpdateTimeline = "xs:boolean"
		connectionTimelineVisibility = "xs:string"
	}
}
$Header = @{
	"Authorization" = "ESP-APIKEY yourHornbillAPIKey"
}
$Parameters = @{
	Method      = "POST"
	Uri         = $Endpoint
	Headers     = $Header
	Body        = ($Body | ConvertTo-Json)
	ContentType = "application/json"
}
Invoke-RestMethod @Parameters

      import requests
import json
endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager/KnownErrors"
headers = {   
    "Authorization": "ESP-APIKEY yourHornbillAPIKey"
}
payload={
        "@service":"apps/com.hornbill.servicemanager/KnownErrors",
        "@method":"logKnownError",
        "params":{
            "summary":"xs:string",
            "description":"xs:string",
            "requestType":"xs:string",
            "customerId":"xs:string",
            "customerType":"xs:string",
            "ownerId":"xs:string",
            "teamId":"xs:string",
            "employeeAssignmentId":"xs:string",
            "status":"xs:string",
            "priorityId":"xs:string",
            "categoryId":"xs:string",
            "categoryName":"xs:string",
            "image":"xs:string",
            "sourceType":"xs:string",
            "sourceId":"xs:string",
            "assetId":"xs:string",
            "impact":"xs:string",
            "urgencyId":"xs:string",
            "serviceId":"xs:string",
            "questions":"xs:string",
            "resolutionDetails":"xs:string",
            "rootCause":"xs:string",
            "stepsToResolve":"xs:string",
            "fileName":"xs:string",
            "siteId":"xs:string",
            "siteName":"xs:string",
            "catalogId":"xs:string",
            "catalogName":"xs:string",
            "externalRefNumber":"xs:string",
            "bpmName":"xs:string",
            "questionFieldMap":"xs:string",
            "connectionMap":"xs:string",
            "connectionUpdateTimeline":"xs:boolean",
            "connectionTimelineVisibility":"xs:string",
        },
}
response = requests.request("POST", endpoint, json=payload, headers=headers)
print(response.text)

{{docApp.title}}

{{docApp.description}}

How can we help?

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

{{resultItem.title}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{group.title || group.id}}

{{group.title}}

Entity API / logKnownError

Operation Information

Description

Request Parameters

Response Parameters

Code Examples

{{docApp.title}}

{{docApp.description}}

How can we help?

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}} Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

{{resultItem.title}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{group.title || group.id}}

{{group.title}}

Entity API / logKnownError

Operation Information

Description

Request Parameters

Response Parameters

Code Examples

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.