Skip to main content
Server path: /haloitsm-knowledge | Type: Application | PCID required: Yes

​
Tools

ToolDescription
haloitsm_knowledge_bookmark_report_bookmarkPOST /Report/Bookmark
haloitsm_knowledge_create_feedbackPOST /Feedback
haloitsm_knowledge_create_kbarticlePOST /KBArticle
haloitsm_knowledge_create_reportPOST /Report
haloitsm_knowledge_delete_feedback_by_idDELETE /Feedback/{id}
haloitsm_knowledge_delete_kbarticle_by_idDELETE /KBArticle/{id}
haloitsm_knowledge_delete_report_by_idDELETE /Report/{id}
haloitsm_knowledge_get_feedback_by_idGet one Feedback
haloitsm_knowledge_get_kbarticle_by_idGet one KBEntry
haloitsm_knowledge_get_report_by_idGet one AnalyzerProfile
haloitsm_knowledge_list_feedbackGET /Feedback
haloitsm_knowledge_list_feedback_feedback_messageGET /Feedback/FeedbackMessage
haloitsm_knowledge_list_kbarticleList of KBEntry
haloitsm_knowledge_list_reportList of AnalyzerProfile
haloitsm_knowledge_vote_kbarticle_votePOST /KBArticle/vote

​
haloitsm_knowledge_bookmark_report_bookmark

POST /Report/Bookmark Parameters:
ParameterTypeRequiredDefaultDescription
_canupdatebooleanNo—The canupdate value
_check_promptbooleanNo—Check Prompt
_do_ai_analysisbooleanNo—Do Ai Analysis
_json_generatebooleanNo—Json Generate
_loadreportonlybooleanNo—The loadreportonly value
_print_generatebooleanNo—Print Generate
_print_previewbooleanNo—Print Preview
_refreshforecastbooleanNo—The refreshforecast value
_run_promptbooleanNo—Run Prompt
_testchartbooleanNo—The testchart value
_testonlybooleanNo—The testonly value
_warningstringNo—The warning value
_xls_generatebooleanNo—Xls Generate
access_controlobject[]No—Access Control
access_control_levelintegerNo—Access Control Level
ai_analysisstringNo—Ai Analysis
ai_analysis_generation_datetimestringNo—Ai Analysis Generation Datetime
ai_promptstringNo—Ai Prompt
ai_runidstringNo—Ai Runid
ai_threadidstringNo—Ai Threadid
ai_user_promptstringNo—Ai User Prompt
alreadyconvertedbooleanNo—The alreadyconverted value
apiquery_idintegerNo—Apiquery Id
apply_query_builder_permsbooleanNo—Apply Query Builder Perms
asset_idintegerNo—Asset Id
assistant_requestobjectNo—Assistant Request
available_columnsobject[]No—Available Columns
availablefieldsstringNo—The availablefields value
averagebooleanNo—The average value
averageaspercentagebooleanNo—The averageaspercentage value
bookmarkedbooleanNo—The bookmarked value
builtinidbooleanNo—The builtinid value
canbeaccessedbyallusersbooleanNo—The canbeaccessedbyallusers value
chart_base64stringNo—Chart Base64
chart_carry_forwardbooleanNo—Chart Carry Forward
chart_comparisonintegerNo—Chart Comparison
chart_paddingintegerNo—Chart Padding
charttitlestringNo—The charttitle value
charttypeintegerNo—The charttype value
clientstringNo—The client value
client_idintegerNo—Client Id
client_page_sizeintegerNo—Client Page Size
colourpallettestringNo—The colourpallette value
coloursobject[]No—The colours value
columnsobject[]No—The columns value
conditionsobject[]No—The conditions value
consignment_idintegerNo—Consignment Id
contract_idintegerNo—Contract Id
countbooleanNo—The count value
created_byintegerNo—Created By
csv_attachment_idintegerNo—Csv Attachment Id
csv_attachment_linkstringNo—Csv Attachment Link
currency_symbolstringNo—Currency Symbol
customise_table_htmlbooleanNo—Customise Table Html
data_label_minnumberNo—Data Label Min
datasource_guidstringNo—Datasource Guid
datasource_idintegerNo—Datasource Id
date_createdstringNo—Date Created
descriptionstringNo—The description value
filter_lookup_valuesobject[]No—Filter Lookup Values
filterable_columnsobject[]No—Filterable Columns
filterable_columns_conditionsobject[]No—Filterable Columns Conditions
filterbarsbyfieldstringNo—The filterbarsbyfield value
filterbarsbyfield_allowchangebooleanNo—Filterbarsbyfield Allowchange
filtersobject[]No—The filters value
forecast_idintegerNo—Forecast Id
format_values_as_currencybooleanNo—Format Values As Currency
get_reportcondition_valuesstringNo—Get Reportcondition Values
get_reportfield_valuesstringNo—Get Reportfield Values
graphorderintegerNo—The graphorder value
graphorderbystringNo—The graphorderby value
group_idintegerNo—Group Id
group_namestringNo—Group Name
guidstringNo—The guid value
guide_htmlstringNo—Guide Html
idintegerNo—The id value
includesummarybooleanNo—The includesummary value
intentstringNo—The intent value
invoice_idintegerNo—Invoice Id
is_onlinerepository_reportbooleanNo—Is Onlinerepository Report
is_publishedbooleanNo—Is Published
json_attachment_idintegerNo—Json Attachment Id
json_attachment_linkstringNo—Json Attachment Link
label_display_typeintegerNo—Label Display Type
last_run_datestringNo—Last Run Date
last_updatedstringNo—Last Updated
last_updated_byintegerNo—Last Updated By
local_library_idintegerNo—Local Library Id
mainentitystringNo—The mainentity value
namestringNo—The name value
online_datasource_idintegerNo—Online Datasource Id
online_idintegerNo—Online Id
onlyshowsummariesbooleanNo—The onlyshowsummaries value
pdf_attachment_idintegerNo—Pdf Attachment Id
pdftemplateobjectNo—The pdftemplate value
pdftemplate_idintegerNo—Pdftemplate Id
pdftemplate_namestringNo—Pdftemplate Name
permissions_agentobject[]No—Permissions Agent
permissions_userobject[]No—Permissions User
previous_reportobjectNo—Previous Report
printhtmlstringNo—The printhtml value
publish_typeintegerNo—Publish Type
published_idstringNo—Published Id
purchase_order_idintegerNo—Purchase Order Id
quote_idintegerNo—Quote Id
reportobjectNo—The report value
report_access_tokenstringNo—Report Access Token
report_comparisonintegerNo—Report Comparison
report_table_autosize_widthbooleanNo—Report Table Autosize Width
report_table_group_htmlstringNo—Report Table Group Html
report_table_htmlstringNo—Report Table Html
report_table_row_htmlstringNo—Report Table Row Html
report_table_total_htmlstringNo—Report Table Total Html
reporting_period_date_onlybooleanNo—Reporting Period Date Only
reportingperiodintegerNo—The reportingperiod value
reportingperioddatefieldstringNo—The reportingperioddatefield value
reportingperiodenddatestringNo—The reportingperiodenddate value
reportingperiodstartdatestringNo—The reportingperiodstartdate value
reportsobject[]No—The reports value
restrictaccessbooleanNo—The restrictaccess value
run_ai_analysis_before_schedulebooleanNo—Run Ai Analysis Before Schedule
sales_order_idintegerNo—Sales Order Id
scheduleobject[]No—The schedule value
selectedfieldsstringNo—The selectedfields value
seriesobject[]No—The series value
seriestype1integerNo—The seriestype1 value
seriestype2integerNo—The seriestype2 value
seriestype3integerNo—The seriestype3 value
seriestype4integerNo—The seriestype4 value
seriestype5integerNo—The seriestype5 value
show_datavaluesbooleanNo—Show Datavalues
show_forecast_chartbooleanNo—Show Forecast Chart
show_forecast_tablebooleanNo—Show Forecast Table
show_top_onlybooleanNo—Show Top Only
show_trendlinebooleanNo—Show Trendline
showgraphvaluesbooleanNo—The showgraphvalues value
sqlstringNo—The sql value
sqlhasdatefilterbooleanNo—The sqlhasdatefilter value
sqlidintegerNo—The sqlid value
stackbarsbooleanNo—The stackbars value
sumbooleanNo—The sum value
systemreportidintegerNo—The systemreportid value
ticket_idintegerNo—Ticket Id
timezonenamestringNo—The timezonename value
top_countintegerNo—Top Count
typeintegerNo—The type value
usesdynamicsqlbooleanNo—The usesdynamicsql value
usetechlinkbooleanNo—The usetechlink value
xaxisstringNo—The xaxis value
xaxiscaptionstringNo—The xaxiscaption value
xls_attachment_idintegerNo—Xls Attachment Id
xls_attachment_linkstringNo—Xls Attachment Link
yaxisstringNo—The yaxis value
yaxis1stringNo—The yaxis1 value
yaxis2stringNo—The yaxis2 value
yaxis3stringNo—The yaxis3 value
yaxis4stringNo—The yaxis4 value
yaxis5stringNo—The yaxis5 value
yaxiscaptionstringNo—The yaxiscaption value

​
haloitsm_knowledge_create_feedback

POST /Feedback Parameters:
ParameterTypeRequiredDefaultDescription
bodyobject[]No—Request body

​
haloitsm_knowledge_create_kbarticle

POST /KBArticle Parameters:
ParameterTypeRequiredDefaultDescription
bodyobject[]No—Request body

​
haloitsm_knowledge_create_report

POST /Report Parameters:
ParameterTypeRequiredDefaultDescription
bodyobject[]No—Request body

​
haloitsm_knowledge_delete_feedback_by_id

DELETE /Feedback/{id} Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYes—The id value

​
haloitsm_knowledge_delete_kbarticle_by_id

DELETE /KBArticle/{id} Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYes—The id value

​
haloitsm_knowledge_delete_report_by_id

DELETE /Report/{id} Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYes—The id value

​
haloitsm_knowledge_get_feedback_by_id

Get one Feedback Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYes—The id value
clearcommentbooleanNo—The clearcomment value
includedetailsbooleanNo—The includedetails value
keystringNo—The key value

​
haloitsm_knowledge_get_kbarticle_by_id

Get one KBEntry Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYes—The id value
includedetailsbooleanNo—(bool) Include extra objects in the response.
language_codestringNo—Language Code
language_overridestringNo—Language Override
organisation_idintegerNo—Organisation Id

​
haloitsm_knowledge_get_report_by_id

Get one AnalyzerProfile Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYes—The id value
client_idintegerNo—Client Id
clientnamestringNo—The clientname value
dashboard_idintegerNo—Dashboard Id
dashboard_published_idstringNo—Dashboard Published Id
dontloadsystemreportbooleanNo—The dontloadsystemreport value
getcompositetokenbooleanNo—The getcompositetoken value
includedetailsbooleanNo—The includedetails value
invoice_idintegerNo—Invoice Id
loadreportbooleanNo—The loadreport value
report_access_tokenstringNo—Report Access Token
reportingperiodintegerNo—The reportingperiod value
reportingperiodenddatestringNo—The reportingperiodenddate value
reportingperiodstartdatestringNo—The reportingperiodstartdate value

​
haloitsm_knowledge_list_feedback

GET /Feedback

​
haloitsm_knowledge_list_feedback_feedback_message

GET /Feedback/FeedbackMessage

​
haloitsm_knowledge_list_kbarticle

List of KBEntry Parameters:
ParameterTypeRequiredDefaultDescription
activeinactivestringNo—(string) Filter on active/inactive assets - comma seperated, first value being true or false for active, second for inactive.
advanced_searchstringNo—Advanced Search
articletypestringNo—(string) Filter on article type, comma seperated.
client_idintegerNo—(int) Filters by the specified client.
countintegerNo—(int) Number of Knowledge Base Entries to return in the response.
device_idintegerNo—Device Id
faqlistsstringNo—(int) Filters response based on the Knowledge Base Article FAQ lists.
includeactivebooleanNo—(bool) Include active Knowledge Base Entries in the response.
includeinactivebooleanNo—(bool) Include inactive Knowledge Base Entries in the response.
keystringNo—(string) Filters response based on the knowledge base key.
language_codestringNo—Language Code
language_overridestringNo—Language Override
needsreviewstringNo—(string) Filter on Knowdledge Base Articles that are past their next review date.
orderstringNo—(string) The name of the field to order by first.
order2stringNo—(string) The name of the field to order by second.
order3stringNo—(string) The name of the field to order by third.
order4stringNo—(string) The name of the field to order by fourth.
order5stringNo—(string) The name of the field to order by fifth.
orderdescbooleanNo—(bool) Whether to order ascending or descending on first order.
orderdesc2booleanNo—(bool) Whether to order ascending or descending on second order.
orderdesc3booleanNo—(bool) Whether to order ascending or descending on third order.
orderdesc4booleanNo—(bool) Whether to order ascending or descending on fourth order.
orderdesc5booleanNo—(bool) Whether to order ascending or descending on fifth order.
organisation_idintegerNo—(int) Filters by Knowdledge Base Articles belonging to a particular organisation.
page_nointegerNo—(int) When using Pagination, the page number to return.
page_sizeintegerNo—(int) When using Pagination, the size of the page.
pageinatebooleanNo—(bool) Whether to use Pagination in the response.
related_tointegerNo—(int) Filters response based on the related Knowledge Base Article.
related_to_ticketintegerNo—(int) Filters response based on the related ticket.
searchstringNo—(string) Filters response based on the search string.
site_idintegerNo—(int) Filters by the specified site.
typeintegerNo—(int) Filters response based on the Knowledge Base Article type.

​
haloitsm_knowledge_list_report

List of AnalyzerProfile Parameters:
ParameterTypeRequiredDefaultDescription
agentrestrictionintegerNo—The agentrestriction value
chartonlybooleanNo—The chartonly value
clientnamestringNo—The clientname value
countintegerNo—The count value
includepublishedbooleanNo—The includepublished value
orderstringNo—The order value
order2stringNo—The order2 value
order3stringNo—The order3 value
order4stringNo—The order4 value
order5stringNo—The order5 value
orderdescbooleanNo—The orderdesc value
orderdesc2booleanNo—The orderdesc2 value
orderdesc3booleanNo—The orderdesc3 value
orderdesc4booleanNo—The orderdesc4 value
orderdesc5booleanNo—The orderdesc5 value
page_nointegerNo—Page No
page_sizeintegerNo—Number of results per page
pageinatebooleanNo—The pageinate value
reportgroup_idintegerNo—Reportgroup Id
searchstringNo—The search value
typeintegerNo—The type value

​
haloitsm_knowledge_vote_kbarticle_vote

POST /KBArticle/vote Parameters:
ParameterTypeRequiredDefaultDescription
bodyobject[]No—Request body