> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# haloitsm-knowledge
> HaloITSM Knowledge - Knowledge base articles, feedback, and reports
**Server path:** `/haloitsm-knowledge` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| --------------------------------------------------------------------------------------------------------- | ----------------------------- |
| [`haloitsm_knowledge_bookmark_report_bookmark`](#haloitsm_knowledge_bookmark_report_bookmark) | POST /Report/Bookmark |
| [`haloitsm_knowledge_create_feedback`](#haloitsm_knowledge_create_feedback) | POST /Feedback |
| [`haloitsm_knowledge_create_kbarticle`](#haloitsm_knowledge_create_kbarticle) | POST /KBArticle |
| [`haloitsm_knowledge_create_report`](#haloitsm_knowledge_create_report) | POST /Report |
| [`haloitsm_knowledge_delete_feedback_by_id`](#haloitsm_knowledge_delete_feedback_by_id) | DELETE /Feedback/\{id} |
| [`haloitsm_knowledge_delete_kbarticle_by_id`](#haloitsm_knowledge_delete_kbarticle_by_id) | DELETE /KBArticle/\{id} |
| [`haloitsm_knowledge_delete_report_by_id`](#haloitsm_knowledge_delete_report_by_id) | DELETE /Report/\{id} |
| [`haloitsm_knowledge_get_feedback_by_id`](#haloitsm_knowledge_get_feedback_by_id) | Get one Feedback |
| [`haloitsm_knowledge_get_kbarticle_by_id`](#haloitsm_knowledge_get_kbarticle_by_id) | Get one KBEntry |
| [`haloitsm_knowledge_get_report_by_id`](#haloitsm_knowledge_get_report_by_id) | Get one AnalyzerProfile |
| [`haloitsm_knowledge_list_feedback`](#haloitsm_knowledge_list_feedback) | GET /Feedback |
| [`haloitsm_knowledge_list_feedback_feedback_message`](#haloitsm_knowledge_list_feedback_feedback_message) | GET /Feedback/FeedbackMessage |
| [`haloitsm_knowledge_list_kbarticle`](#haloitsm_knowledge_list_kbarticle) | List of KBEntry |
| [`haloitsm_knowledge_list_report`](#haloitsm_knowledge_list_report) | List of AnalyzerProfile |
| [`haloitsm_knowledge_vote_kbarticle_vote`](#haloitsm_knowledge_vote_kbarticle_vote) | POST /KBArticle/vote |
***
## haloitsm\_knowledge\_bookmark\_report\_bookmark
POST /Report/Bookmark
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| --------------------------------- | --------- | -------- | ------- | ----------------------------- | ---------------------------------- |
| `_canupdate` | boolean | null | No | — | The canupdate value |
| `_check_prompt` | boolean | null | No | — | Check Prompt |
| `_do_ai_analysis` | boolean | null | No | — | Do Ai Analysis |
| `_json_generate` | boolean | null | No | — | Json Generate |
| `_loadreportonly` | boolean | null | No | — | The loadreportonly value |
| `_print_generate` | boolean | null | No | — | Print Generate |
| `_print_preview` | boolean | null | No | — | Print Preview |
| `_refreshforecast` | boolean | null | No | — | The refreshforecast value |
| `_run_prompt` | boolean | null | No | — | Run Prompt |
| `_testchart` | boolean | null | No | — | The testchart value |
| `_testonly` | boolean | null | No | — | The testonly value |
| `_warning` | string | null | No | — | The warning value |
| `_xls_generate` | boolean | null | No | — | Xls Generate |
| `access_control` | object\[] | No | — | Access Control | |
| `access_control_level` | integer | null | No | — | Access Control Level |
| `ai_analysis` | string | null | No | — | Ai Analysis |
| `ai_analysis_generation_datetime` | string | null | No | — | Ai Analysis Generation Datetime |
| `ai_prompt` | string | null | No | — | Ai Prompt |
| `ai_runid` | string | null | No | — | Ai Runid |
| `ai_threadid` | string | null | No | — | Ai Threadid |
| `ai_user_prompt` | string | null | No | — | Ai User Prompt |
| `alreadyconverted` | boolean | null | No | — | The alreadyconverted value |
| `apiquery_id` | integer | null | No | — | Apiquery Id |
| `apply_query_builder_perms` | boolean | null | No | — | Apply Query Builder Perms |
| `asset_id` | integer | null | No | — | Asset Id |
| `assistant_request` | object | No | — | Assistant Request | |
| `available_columns` | object\[] | No | — | Available Columns | |
| `availablefields` | string | null | No | — | The availablefields value |
| `average` | boolean | null | No | — | The average value |
| `averageaspercentage` | boolean | null | No | — | The averageaspercentage value |
| `bookmarked` | boolean | null | No | — | The bookmarked value |
| `builtinid` | boolean | null | No | — | The builtinid value |
| `canbeaccessedbyallusers` | boolean | null | No | — | The canbeaccessedbyallusers value |
| `chart_base64` | string | null | No | — | Chart Base64 |
| `chart_carry_forward` | boolean | null | No | — | Chart Carry Forward |
| `chart_comparison` | integer | null | No | — | Chart Comparison |
| `chart_padding` | integer | null | No | — | Chart Padding |
| `charttitle` | string | null | No | — | The charttitle value |
| `charttype` | integer | null | No | — | The charttype value |
| `client` | string | null | No | — | The client value |
| `client_id` | integer | null | No | — | Client Id |
| `client_page_size` | integer | null | No | — | Client Page Size |
| `colourpallette` | string | null | No | — | The colourpallette value |
| `colours` | object\[] | No | — | The colours value | |
| `columns` | object\[] | No | — | The columns value | |
| `conditions` | object\[] | No | — | The conditions value | |
| `consignment_id` | integer | null | No | — | Consignment Id |
| `contract_id` | integer | null | No | — | Contract Id |
| `count` | boolean | null | No | — | The count value |
| `created_by` | integer | null | No | — | Created By |
| `csv_attachment_id` | integer | null | No | — | Csv Attachment Id |
| `csv_attachment_link` | string | null | No | — | Csv Attachment Link |
| `currency_symbol` | string | null | No | — | Currency Symbol |
| `customise_table_html` | boolean | null | No | — | Customise Table Html |
| `data_label_min` | number | null | No | — | Data Label Min |
| `datasource_guid` | string | null | No | — | Datasource Guid |
| `datasource_id` | integer | null | No | — | Datasource Id |
| `date_created` | string | null | No | — | Date Created |
| `description` | string | null | No | — | The description value |
| `filter_lookup_values` | object\[] | No | — | Filter Lookup Values | |
| `filterable_columns` | object\[] | No | — | Filterable Columns | |
| `filterable_columns_conditions` | object\[] | No | — | Filterable Columns Conditions | |
| `filterbarsbyfield` | string | null | No | — | The filterbarsbyfield value |
| `filterbarsbyfield_allowchange` | boolean | null | No | — | Filterbarsbyfield Allowchange |
| `filters` | object\[] | No | — | The filters value | |
| `forecast_id` | integer | null | No | — | Forecast Id |
| `format_values_as_currency` | boolean | null | No | — | Format Values As Currency |
| `get_reportcondition_values` | string | null | No | — | Get Reportcondition Values |
| `get_reportfield_values` | string | null | No | — | Get Reportfield Values |
| `graphorder` | integer | null | No | — | The graphorder value |
| `graphorderby` | string | null | No | — | The graphorderby value |
| `group_id` | integer | null | No | — | Group Id |
| `group_name` | string | null | No | — | Group Name |
| `guid` | string | null | No | — | The guid value |
| `guide_html` | string | null | No | — | Guide Html |
| `id` | integer | No | — | The id value | |
| `includesummary` | boolean | null | No | — | The includesummary value |
| `intent` | string | null | No | — | The intent value |
| `invoice_id` | integer | null | No | — | Invoice Id |
| `is_onlinerepository_report` | boolean | null | No | — | Is Onlinerepository Report |
| `is_published` | boolean | null | No | — | Is Published |
| `json_attachment_id` | integer | null | No | — | Json Attachment Id |
| `json_attachment_link` | string | null | No | — | Json Attachment Link |
| `label_display_type` | integer | null | No | — | Label Display Type |
| `last_run_date` | string | null | No | — | Last Run Date |
| `last_updated` | string | null | No | — | Last Updated |
| `last_updated_by` | integer | null | No | — | Last Updated By |
| `local_library_id` | integer | null | No | — | Local Library Id |
| `mainentity` | string | null | No | — | The mainentity value |
| `name` | string | null | No | — | The name value |
| `online_datasource_id` | integer | null | No | — | Online Datasource Id |
| `online_id` | integer | null | No | — | Online Id |
| `onlyshowsummaries` | boolean | null | No | — | The onlyshowsummaries value |
| `pdf_attachment_id` | integer | null | No | — | Pdf Attachment Id |
| `pdftemplate` | object | No | — | The pdftemplate value | |
| `pdftemplate_id` | integer | null | No | — | Pdftemplate Id |
| `pdftemplate_name` | string | null | No | — | Pdftemplate Name |
| `permissions_agent` | object\[] | No | — | Permissions Agent | |
| `permissions_user` | object\[] | No | — | Permissions User | |
| `previous_report` | object | No | — | Previous Report | |
| `printhtml` | string | null | No | — | The printhtml value |
| `publish_type` | integer | null | No | — | Publish Type |
| `published_id` | string | null | No | — | Published Id |
| `purchase_order_id` | integer | null | No | — | Purchase Order Id |
| `quote_id` | integer | null | No | — | Quote Id |
| `report` | object | No | — | The report value | |
| `report_access_token` | string | null | No | — | Report Access Token |
| `report_comparison` | integer | null | No | — | Report Comparison |
| `report_table_autosize_width` | boolean | null | No | — | Report Table Autosize Width |
| `report_table_group_html` | string | null | No | — | Report Table Group Html |
| `report_table_html` | string | null | No | — | Report Table Html |
| `report_table_row_html` | string | null | No | — | Report Table Row Html |
| `report_table_total_html` | string | null | No | — | Report Table Total Html |
| `reporting_period_date_only` | boolean | null | No | — | Reporting Period Date Only |
| `reportingperiod` | integer | null | No | — | The reportingperiod value |
| `reportingperioddatefield` | string | null | No | — | The reportingperioddatefield value |
| `reportingperiodenddate` | string | null | No | — | The reportingperiodenddate value |
| `reportingperiodstartdate` | string | null | No | — | The reportingperiodstartdate value |
| `reports` | object\[] | No | — | The reports value | |
| `restrictaccess` | boolean | null | No | — | The restrictaccess value |
| `run_ai_analysis_before_schedule` | boolean | null | No | — | Run Ai Analysis Before Schedule |
| `sales_order_id` | integer | null | No | — | Sales Order Id |
| `schedule` | object\[] | No | — | The schedule value | |
| `selectedfields` | string | null | No | — | The selectedfields value |
| `series` | object\[] | No | — | The series value | |
| `seriestype1` | integer | null | No | — | The seriestype1 value |
| `seriestype2` | integer | null | No | — | The seriestype2 value |
| `seriestype3` | integer | null | No | — | The seriestype3 value |
| `seriestype4` | integer | null | No | — | The seriestype4 value |
| `seriestype5` | integer | null | No | — | The seriestype5 value |
| `show_datavalues` | boolean | null | No | — | Show Datavalues |
| `show_forecast_chart` | boolean | null | No | — | Show Forecast Chart |
| `show_forecast_table` | boolean | null | No | — | Show Forecast Table |
| `show_top_only` | boolean | null | No | — | Show Top Only |
| `show_trendline` | boolean | null | No | — | Show Trendline |
| `showgraphvalues` | boolean | null | No | — | The showgraphvalues value |
| `sql` | string | null | No | — | The sql value |
| `sqlhasdatefilter` | boolean | null | No | — | The sqlhasdatefilter value |
| `sqlid` | integer | null | No | — | The sqlid value |
| `stackbars` | boolean | null | No | — | The stackbars value |
| `sum` | boolean | null | No | — | The sum value |
| `systemreportid` | integer | null | No | — | The systemreportid value |
| `ticket_id` | integer | null | No | — | Ticket Id |
| `timezonename` | string | null | No | — | The timezonename value |
| `top_count` | integer | null | No | — | Top Count |
| `type` | integer | null | No | — | The type value |
| `usesdynamicsql` | boolean | null | No | — | The usesdynamicsql value |
| `usetechlink` | boolean | null | No | — | The usetechlink value |
| `xaxis` | string | null | No | — | The xaxis value |
| `xaxiscaption` | string | null | No | — | The xaxiscaption value |
| `xls_attachment_id` | integer | null | No | — | Xls Attachment Id |
| `xls_attachment_link` | string | null | No | — | Xls Attachment Link |
| `yaxis` | string | null | No | — | The yaxis value |
| `yaxis1` | string | null | No | — | The yaxis1 value |
| `yaxis2` | string | null | No | — | The yaxis2 value |
| `yaxis3` | string | null | No | — | The yaxis3 value |
| `yaxis4` | string | null | No | — | The yaxis4 value |
| `yaxis5` | string | null | No | — | The yaxis5 value |
| `yaxiscaption` | string | null | No | — | The yaxiscaption value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"_canupdate": {
"type": [
"boolean",
"null"
],
"description": "The canupdate value"
},
"_check_prompt": {
"type": [
"boolean",
"null"
],
"description": "Check Prompt"
},
"_do_ai_analysis": {
"type": [
"boolean",
"null"
],
"description": "Do Ai Analysis"
},
"_json_generate": {
"type": [
"boolean",
"null"
],
"description": "Json Generate"
},
"_loadreportonly": {
"type": [
"boolean",
"null"
],
"description": "The loadreportonly value"
},
"_print_generate": {
"type": [
"boolean",
"null"
],
"description": "Print Generate"
},
"_print_preview": {
"type": [
"boolean",
"null"
],
"description": "Print Preview"
},
"_refreshforecast": {
"type": [
"boolean",
"null"
],
"description": "The refreshforecast value"
},
"_run_prompt": {
"type": [
"boolean",
"null"
],
"description": "Run Prompt"
},
"_testchart": {
"type": [
"boolean",
"null"
],
"description": "The testchart value"
},
"_testonly": {
"type": [
"boolean",
"null"
],
"description": "The testonly value"
},
"_warning": {
"type": [
"string",
"null"
],
"description": "The warning value"
},
"_xls_generate": {
"type": [
"boolean",
"null"
],
"description": "Xls Generate"
},
"access_control": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "The id value"
},
"entity": {
"type": "string",
"description": "The entity value"
},
"entity_id": {
"type": "integer",
"format": "int32",
"description": "Entity Id"
},
"type": {
"type": "integer",
"format": "int32",
"description": "The type value"
},
"agent_id": {
"type": "integer",
"format": "int32",
"description": "Agent Id"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User Id"
},
"role_id": {
"type": "integer",
"format": "int32",
"description": "Role Id"
},
"team_id": {
"type": "integer",
"format": "int32",
"description": "Team Id"
},
"team_guid": {
"type": "string",
"format": "uuid",
"description": "Team Guid"
},
"department_id": {
"type": "integer",
"format": "int32",
"description": "Department Id"
},
"department_guid": {
"type": "string",
"format": "uuid",
"description": "Department Guid"
},
"name": {
"type": "string",
"description": "The name value"
},
"level": {
"type": "integer",
"format": "int32",
"description": "The level value"
},
"_warning": {
"type": "string",
"description": "The warning value"
},
"entity_name": {
"type": "string",
"description": "Entity Name"
},
"entity_text_id": {
"type": "string",
"description": "Entity Text Id"
}
}
},
"description": "Access Control"
},
"access_control_level": {
"type": [
"integer",
"null"
],
"description": "Access Control Level"
},
"ai_analysis": {
"type": [
"string",
"null"
],
"description": "Ai Analysis"
},
"ai_analysis_generation_datetime": {
"type": [
"string",
"null"
],
"description": "Ai Analysis Generation Datetime"
},
"ai_prompt": {
"type": [
"string",
"null"
],
"description": "Ai Prompt"
},
"ai_runid": {
"type": [
"string",
"null"
],
"description": "Ai Runid"
},
"ai_threadid": {
"type": [
"string",
"null"
],
"description": "Ai Threadid"
},
"ai_user_prompt": {
"type": [
"string",
"null"
],
"description": "Ai User Prompt"
},
"alreadyconverted": {
"type": [
"boolean",
"null"
],
"description": "The alreadyconverted value"
},
"apiquery_id": {
"type": [
"integer",
"null"
],
"description": "Apiquery Id"
},
"apply_query_builder_perms": {
"type": [
"boolean",
"null"
],
"description": "Apply Query Builder Perms"
},
"asset_id": {
"type": [
"integer",
"null"
],
"description": "Asset Id"
},
"assistant_request": {
"type": "object",
"description": "Assistant Request",
"properties": {
"id": {
"type": "integer",
"description": "The id value"
},
"assistant_id": {
"type": "string",
"description": "Assistant Id"
},
"thread_id": {
"type": "string",
"description": "Thread Id"
},
"run_id": {
"type": "string",
"description": "Run Id"
},
"entity_id": {
"type": "integer",
"description": "Entity Id"
},
"prompt": {
"type": "string",
"description": "The prompt value"
},
"status": {
"type": "integer",
"description": "The status value"
},
"iterations": {
"type": "integer",
"description": "The iterations value"
},
"timestamp": {
"type": "string",
"description": "The timestamp value"
},
"error_message": {
"type": "string",
"description": "Error Message"
},
"query": {
"type": "string",
"description": "Search query string"
}
}
},
"available_columns": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "The id value"
},
"report_id": {
"type": "integer",
"format": "int32",
"description": "Report Id"
},
"name": {
"type": "string",
"description": "The name value"
},
"sys_name": {
"type": "string",
"description": "Sys Name"
},
"query": {
"type": "string",
"description": "Search query string"
},
"data_type": {
"type": "string",
"description": "Data Type"
},
"data_type_group": {
"type": "string",
"description": "Data Type Group"
},
"select_format": {
"type": "string",
"description": "Select Format"
},
"table_name": {
"type": "string",
"description": "Table Name"
},
"customextratableid": {
"type": "integer",
"format": "int32",
"description": "The customextratableid value"
},
"sequence": {
"type": "integer",
"format": "int32",
"description": "The sequence value"
},
"filter": {
"type": "string",
"description": "The filter value"
},
"operation": {
"type": "integer",
"format": "int32",
"description": "The operation value"
},
"groupbystatus": {
"type": "integer",
"format": "int32",
"description": "The groupbystatus value"
},
"groupbycalc": {
"type": "integer",
"format": "int32",
"description": "The groupbycalc value"
},
"hidden": {
"type": "boolean",
"description": "The hidden value"
},
"labellong": {
"type": "string",
"description": "The labellong value"
},
"orderby": {
"type": "integer",
"format": "int32",
"description": "The orderby value"
},
"orderby_desc": {
"type": "boolean",
"description": "Orderby Desc"
},
"allowlookup": {
"type": "boolean",
"description": "The allowlookup value"
},
"is_identifier": {
"type": "boolean",
"description": "Is Identifier"
},
"is_money_field": {
"type": "boolean",
"description": "Is Money Field"
},
"translatedname": {
"type": "string",
"description": "The translatedname value"
},
"translations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"language_id": {
"type": "integer"
},
"entity": {
"type": "string"
},
"fieldname": {
"type": "string"
},
"entity_id": {
"type": "integer"
},
"entity_id2": {
"type": "integer"
},
"entity_id3": {
"type": "integer"
},
"entity_textid": {
"type": "string"
},
"translation": {
"type": "string"
},
"_dotranslate": {
"type": "boolean"
},
"_translateonly": {
"type": "boolean"
},
"_isimport": {
"type": "boolean"
},
"default_translation": {
"type": "string"
},
"_warning": {
"type": "string"
}
}
},
"description": "The translations value"
},
"table_alias": {
"type": "string",
"description": "Table Alias"
},
"table_joins": {
"type": "array",
"items": {
"type": "object",
"properties": {
"table_name": {
"type": "string"
},
"table_alias": {
"type": "string"
},
"join_field": {
"type": "string"
}
}
},
"description": "Table Joins"
},
"_warning": {
"type": "string",
"description": "The warning value"
}
}
},
"description": "Available Columns"
},
"availablefields": {
"type": [
"string",
"null"
],
"description": "The availablefields value"
},
"average": {
"type": [
"boolean",
"null"
],
"description": "The average value"
},
"averageaspercentage": {
"type": [
"boolean",
"null"
],
"description": "The averageaspercentage value"
},
"bookmarked": {
"type": [
"boolean",
"null"
],
"description": "The bookmarked value"
},
"builtinid": {
"type": [
"boolean",
"null"
],
"description": "The builtinid value"
},
"canbeaccessedbyallusers": {
"type": [
"boolean",
"null"
],
"description": "The canbeaccessedbyallusers value"
},
"chart_base64": {
"type": [
"string",
"null"
],
"description": "Chart Base64"
},
"chart_carry_forward": {
"type": [
"boolean",
"null"
],
"description": "Chart Carry Forward"
},
"chart_comparison": {
"type": [
"integer",
"null"
],
"description": "Chart Comparison"
},
"chart_padding": {
"type": [
"integer",
"null"
],
"description": "Chart Padding"
},
"charttitle": {
"type": [
"string",
"null"
],
"description": "The charttitle value"
},
"charttype": {
"type": [
"integer",
"null"
],
"description": "The charttype value"
},
"client": {
"type": [
"string",
"null"
],
"description": "The client value"
},
"client_id": {
"type": [
"integer",
"null"
],
"description": "Client Id"
},
"client_page_size": {
"type": [
"integer",
"null"
],
"description": "Client Page Size"
},
"colourpallette": {
"type": [
"string",
"null"
],
"description": "The colourpallette value"
},
"colours": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "The id value"
},
"report_id": {
"type": "integer",
"format": "int32",
"description": "Report Id"
},
"widget_id": {
"type": "integer",
"format": "int32",
"description": "Widget Id"
},
"colour": {
"type": "string",
"description": "The colour value"
},
"min_threshold": {
"type": "integer",
"format": "int32",
"description": "Min Threshold"
},
"name": {
"type": "string",
"description": "The name value"
},
"_warning": {
"type": "string",
"description": "The warning value"
}
}
},
"description": "The colours value"
},
"columns": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "The id value"
},
"report_id": {
"type": "integer",
"format": "int32",
"description": "Report Id"
},
"name": {
"type": "string",
"description": "The name value"
},
"sys_name": {
"type": "string",
"description": "Sys Name"
},
"query": {
"type": "string",
"description": "Search query string"
},
"data_type": {
"type": "string",
"description": "Data Type"
},
"data_type_group": {
"type": "string",
"description": "Data Type Group"
},
"select_format": {
"type": "string",
"description": "Select Format"
},
"table_name": {
"type": "string",
"description": "Table Name"
},
"customextratableid": {
"type": "integer",
"format": "int32",
"description": "The customextratableid value"
},
"sequence": {
"type": "integer",
"format": "int32",
"description": "The sequence value"
},
"filter": {
"type": "string",
"description": "The filter value"
},
"operation": {
"type": "integer",
"format": "int32",
"description": "The operation value"
},
"groupbystatus": {
"type": "integer",
"format": "int32",
"description": "The groupbystatus value"
},
"groupbycalc": {
"type": "integer",
"format": "int32",
"description": "The groupbycalc value"
},
"hidden": {
"type": "boolean",
"description": "The hidden value"
},
"labellong": {
"type": "string",
"description": "The labellong value"
},
"orderby": {
"type": "integer",
"format": "int32",
"description": "The orderby value"
},
"orderby_desc": {
"type": "boolean",
"description": "Orderby Desc"
},
"allowlookup": {
"type": "boolean",
"description": "The allowlookup value"
},
"is_identifier": {
"type": "boolean",
"description": "Is Identifier"
},
"is_money_field": {
"type": "boolean",
"description": "Is Money Field"
},
"translatedname": {
"type": "string",
"description": "The translatedname value"
},
"translations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"language_id": {
"type": "integer"
},
"entity": {
"type": "string"
},
"fieldname": {
"type": "string"
},
"entity_id": {
"type": "integer"
},
"entity_id2": {
"type": "integer"
},
"entity_id3": {
"type": "integer"
},
"entity_textid": {
"type": "string"
},
"translation": {
"type": "string"
},
"_dotranslate": {
"type": "boolean"
},
"_translateonly": {
"type": "boolean"
},
"_isimport": {
"type": "boolean"
},
"default_translation": {
"type": "string"
},
"_warning": {
"type": "string"
}
}
},
"description": "The translations value"
},
"table_alias": {
"type": "string",
"description": "Table Alias"
},
"table_joins": {
"type": "array",
"items": {
"type": "object",
"properties": {
"table_name": {
"type": "string"
},
"table_alias": {
"type": "string"
},
"join_field": {
"type": "string"
}
}
},
"description": "Table Joins"
},
"_warning": {
"type": "string",
"description": "The warning value"
}
}
},
"description": "The columns value"
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "The id value"
},
"report_id": {
"type": "integer",
"format": "int32",
"description": "Report Id"
},
"fieldname": {
"type": "string",
"description": "The fieldname value"
},
"data_type": {
"type": "string",
"description": "Data Type"
},
"data_type_group": {
"type": "string",
"description": "Data Type Group"
},
"query": {
"type": "string",
"description": "Search query string"
},
"numericruletype": {
"type": "integer",
"format": "int32",
"description": "The numericruletype value"
},
"numericvalue": {
"type": "number",
"format": "double",
"description": "The numericvalue value"
},
"stringrulevalues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"label": {
"type": "string"
},
"isnew": {
"type": "boolean"
}
}
},
"description": "The stringrulevalues value"
},
"numericrulevalues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"label": {
"type": "string"
},
"isnew": {
"type": "boolean"
}
}
},
"description": "The numericrulevalues value"
},
"stringruletext": {
"type": "string",
"description": "The stringruletext value"
},
"stringruletype": {
"type": "integer",
"format": "int32",
"description": "The stringruletype value"
},
"_warning": {
"type": "string",
"description": "The warning value"
}
}
},
"description": "The conditions value"
},
"consignment_id": {
"type": [
"integer",
"null"
],
"description": "Consignment Id"
},
"contract_id": {
"type": [
"integer",
"null"
],
"description": "Contract Id"
},
"count": {
"type": [
"boolean",
"null"
],
"description": "The count value"
},
"created_by": {
"type": [
"integer",
"null"
],
"description": "Created By"
},
"csv_attachment_id": {
"type": [
"integer",
"null"
],
"description": "Csv Attachment Id"
},
"csv_attachment_link": {
"type": [
"string",
"null"
],
"description": "Csv Attachment Link"
},
"currency_symbol": {
"type": [
"string",
"null"
],
"description": "Currency Symbol"
},
"customise_table_html": {
"type": [
"boolean",
"null"
],
"description": "Customise Table Html"
},
"data_label_min": {
"type": [
"number",
"null"
],
"description": "Data Label Min"
},
"datasource_guid": {
"type": [
"string",
"null"
],
"description": "Datasource Guid"
},
"datasource_id": {
"type": [
"integer",
"null"
],
"description": "Datasource Id"
},
"date_created": {
"type": [
"string",
"null"
],
"description": "Date Created"
},
"description": {
"type": [
"string",
"null"
],
"description": "The description value"
},
"filter_lookup_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The value value"
},
"label": {
"type": "string",
"description": "The label value"
},
"isnew": {
"type": "boolean",
"description": "The isnew value"
}
}
},
"description": "Filter Lookup Values"
},
"filterable_columns": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "The id value"
},
"report_id": {
"type": "integer",
"format": "int32",
"description": "Report Id"
},
"name": {
"type": "string",
"description": "The name value"
},
"sys_name": {
"type": "string",
"description": "Sys Name"
},
"query": {
"type": "string",
"description": "Search query string"
},
"data_type": {
"type": "string",
"description": "Data Type"
},
"data_type_group": {
"type": "string",
"description": "Data Type Group"
},
"select_format": {
"type": "string",
"description": "Select Format"
},
"table_name": {
"type": "string",
"description": "Table Name"
},
"customextratableid": {
"type": "integer",
"format": "int32",
"description": "The customextratableid value"
},
"sequence": {
"type": "integer",
"format": "int32",
"description": "The sequence value"
},
"filter": {
"type": "string",
"description": "The filter value"
},
"operation": {
"type": "integer",
"format": "int32",
"description": "The operation value"
},
"groupbystatus": {
"type": "integer",
"format": "int32",
"description": "The groupbystatus value"
},
"groupbycalc": {
"type": "integer",
"format": "int32",
"description": "The groupbycalc value"
},
"hidden": {
"type": "boolean",
"description": "The hidden value"
},
"labellong": {
"type": "string",
"description": "The labellong value"
},
"orderby": {
"type": "integer",
"format": "int32",
"description": "The orderby value"
},
"orderby_desc": {
"type": "boolean",
"description": "Orderby Desc"
},
"allowlookup": {
"type": "boolean",
"description": "The allowlookup value"
},
"is_identifier": {
"type": "boolean",
"description": "Is Identifier"
},
"is_money_field": {
"type": "boolean",
"description": "Is Money Field"
},
"translatedname": {
"type": "string",
"description": "The translatedname value"
},
"translations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"language_id": {
"type": "integer"
},
"entity": {
"type": "string"
},
"fieldname": {
"type": "string"
},
"entity_id": {
"type": "integer"
},
"entity_id2": {
"type": "integer"
},
"entity_id3": {
"type": "integer"
},
"entity_textid": {
"type": "string"
},
"translation": {
"type": "string"
},
"_dotranslate": {
"type": "boolean"
},
"_translateonly": {
"type": "boolean"
},
"_isimport": {
"type": "boolean"
},
"default_translation": {
"type": "string"
},
"_warning": {
"type": "string"
}
}
},
"description": "The translations value"
},
"table_alias": {
"type": "string",
"description": "Table Alias"
},
"table_joins": {
"type": "array",
"items": {
"type": "object",
"properties": {
"table_name": {
"type": "string"
},
"table_alias": {
"type": "string"
},
"join_field": {
"type": "string"
}
}
},
"description": "Table Joins"
},
"_warning": {
"type": "string",
"description": "The warning value"
}
}
},
"description": "Filterable Columns"
},
"filterable_columns_conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "The id value"
},
"report_id": {
"type": "integer",
"format": "int32",
"description": "Report Id"
},
"name": {
"type": "string",
"description": "The name value"
},
"sys_name": {
"type": "string",
"description": "Sys Name"
},
"query": {
"type": "string",
"description": "Search query string"
},
"data_type": {
"type": "string",
"description": "Data Type"
},
"data_type_group": {
"type": "string",
"description": "Data Type Group"
},
"select_format": {
"type": "string",
"description": "Select Format"
},
"table_name": {
"type": "string",
"description": "Table Name"
},
"customextratableid": {
"type": "integer",
"format": "int32",
"description": "The customextratableid value"
},
"sequence": {
"type": "integer",
"format": "int32",
"description": "The sequence value"
},
"filter": {
"type": "string",
"description": "The filter value"
},
"operation": {
"type": "integer",
"format": "int32",
"description": "The operation value"
},
"groupbystatus": {
"type": "integer",
"format": "int32",
"description": "The groupbystatus value"
},
"groupbycalc": {
"type": "integer",
"format": "int32",
"description": "The groupbycalc value"
},
"hidden": {
"type": "boolean",
"description": "The hidden value"
},
"labellong": {
"type": "string",
"description": "The labellong value"
},
"orderby": {
"type": "integer",
"format": "int32",
"description": "The orderby value"
},
"orderby_desc": {
"type": "boolean",
"description": "Orderby Desc"
},
"allowlookup": {
"type": "boolean",
"description": "The allowlookup value"
},
"is_identifier": {
"type": "boolean",
"description": "Is Identifier"
},
"is_money_field": {
"type": "boolean",
"description": "Is Money Field"
},
"translatedname": {
"type": "string",
"description": "The translatedname value"
},
"translations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"language_id": {
"type": "integer"
},
"entity": {
"type": "string"
},
"fieldname": {
"type": "string"
},
"entity_id": {
"type": "integer"
},
"entity_id2": {
"type": "integer"
},
"entity_id3": {
"type": "integer"
},
"entity_textid": {
"type": "string"
},
"translation": {
"type": "string"
},
"_dotranslate": {
"type": "boolean"
},
"_translateonly": {
"type": "boolean"
},
"_isimport": {
"type": "boolean"
},
"default_translation": {
"type": "string"
},
"_warning": {
"type": "string"
}
}
},
"description": "The translations value"
},
"table_alias": {
"type": "string",
"description": "Table Alias"
},
"table_joins": {
"type": "array",
"items": {
"type": "object",
"properties": {
"table_name": {
"type": "string"
},
"table_alias": {
"type": "string"
},
"join_field": {
"type": "string"
}
}
},
"description": "Table Joins"
},
"_warning": {
"type": "string",
"description": "The warning value"
}
}
},
"description": "Filterable Columns Conditions"
},
"filterbarsbyfield": {
"type": [
"string",
"null"
],
"description": "The filterbarsbyfield value"
},
"filterbarsbyfield_allowchange": {
"type": [
"boolean",
"null"
],
"description": "Filterbarsbyfield Allowchange"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "The id value"
},
"report_id": {
"type": "integer",
"format": "int32",
"description": "Report Id"
},
"fieldname": {
"type": "string",
"description": "The fieldname value"
},
"data_type": {
"type": "string",
"description": "Data Type"
},
"data_type_group": {
"type": "string",
"description": "Data Type Group"
},
"query": {
"type": "string",
"description": "Search query string"
},
"numericruletype": {
"type": "integer",
"format": "int32",
"description": "The numericruletype value"
},
"numericvalue": {
"type": "number",
"format": "double",
"description": "The numericvalue value"
},
"stringrulevalues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"label": {
"type": "string"
},
"isnew": {
"type": "boolean"
}
}
},
"description": "The stringrulevalues value"
},
"numericrulevalues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"label": {
"type": "string"
},
"isnew": {
"type": "boolean"
}
}
},
"description": "The numericrulevalues value"
},
"stringruletext": {
"type": "string",
"description": "The stringruletext value"
},
"stringruletype": {
"type": "integer",
"format": "int32",
"description": "The stringruletype value"
},
"_warning": {
"type": "string",
"description": "The warning value"
}
}
},
"description": "The filters value"
},
"forecast_id": {
"type": [
"integer",
"null"
],
"description": "Forecast Id"
},
"format_values_as_currency": {
"type": [
"boolean",
"null"
],
"description": "Format Values As Currency"
},
"get_reportcondition_values": {
"type": [
"string",
"null"
],
"description": "Get Reportcondition Values"
},
"get_reportfield_values": {
"type": [
"string",
"null"
],
"description": "Get Reportfield Values"
},
"graphorder": {
"type": [
"integer",
"null"
],
"description": "The graphorder value"
},
"graphorderby": {
"type": [
"string",
"null"
],
"description": "The graphorderby value"
},
"group_id": {
"type": [
"integer",
"null"
],
"description": "Group Id"
},
"group_name": {
"type": [
"string",
"null"
],
"description": "Group Name"
},
"guid": {
"type": [
"string",
"null"
],
"description": "The guid value"
},
"guide_html": {
"type": [
"string",
"null"
],
"description": "Guide Html"
},
"id": {
"type": "integer",
"description": "The id value"
},
"includesummary": {
"type": [
"boolean",
"null"
],
"description": "The includesummary value"
},
"intent": {
"type": [
"string",
"null"
],
"description": "The intent value"
},
"invoice_id": {
"type": [
"integer",
"null"
],
"description": "Invoice Id"
},
"is_onlinerepository_report": {
"type": [
"boolean",
"null"
],
"description": "Is Onlinerepository Report"
},
"is_published": {
"type": [
"boolean",
"null"
],
"description": "Is Published"
},
"json_attachment_id": {
"type": [
"integer",
"null"
],
"description": "Json Attachment Id"
},
"json_attachment_link": {
"type": [
"string",
"null"
],
"description": "Json Attachment Link"
},
"label_display_type": {
"type": [
"integer",
"null"
],
"description": "Label Display Type"
},
"last_run_date": {
"type": [
"string",
"null"
],
"description": "Last Run Date"
},
"last_updated": {
"type": [
"string",
"null"
],
"description": "Last Updated"
},
"last_updated_by": {
"type": [
"integer",
"null"
],
"description": "Last Updated By"
},
"local_library_id": {
"type": [
"integer",
"null"
],
"description": "Local Library Id"
},
"mainentity": {
"type": [
"string",
"null"
],
"description": "The mainentity value"
},
"name": {
"type": [
"string",
"null"
],
"description": "The name value"
},
"online_datasource_id": {
"type": [
"integer",
"null"
],
"description": "Online Datasource Id"
},
"online_id": {
"type": [
"integer",
"null"
],
"description": "Online Id"
},
"onlyshowsummaries": {
"type": [
"boolean",
"null"
],
"description": "The onlyshowsummaries value"
},
"pdf_attachment_id": {
"type": [
"integer",
"null"
],
"description": "Pdf Attachment Id"
},
"pdftemplate": {
"type": "object",
"description": "The pdftemplate value",
"properties": {
"id": {
"type": "integer",
"description": "The id value"
},
"name": {
"type": "string",
"description": "The name value"
},
"type": {
"type": "integer",
"description": "The type value"
},
"description": {
"type": "string",
"description": "The description value"
},
"orientation": {
"type": "integer",
"description": "The orientation value"
},
"margin": {
"type": "integer",
"description": "The margin value"
},
"default_mainhtml": {
"type": "string",
"description": "Default Mainhtml"
},
"default_subhtml": {
"type": "string",
"description": "Default Subhtml"
},
"default_subhtml2": {
"type": "string",
"description": "Default Subhtml2"
},
"default_subhtml3": {
"type": "string",
"description": "Default Subhtml3"
},
"includeheader": {
"type": "boolean",
"description": "The includeheader value"
},
"headerl": {
"type": "string",
"description": "The headerl value"
},
"headerc": {
"type": "string",
"description": "The headerc value"
},
"headerr": {
"type": "string",
"description": "The headerr value"
},
"headerishtml": {
"type": "boolean",
"description": "The headerishtml value"
},
"headerheight": {
"type": "integer",
"description": "The headerheight value"
},
"headerhtml": {
"type": "string",
"description": "The headerhtml value"
},
"includefooter": {
"type": "boolean",
"description": "The includefooter value"
},
"footerl": {
"type": "string",
"description": "The footerl value"
},
"footerc": {
"type": "string",
"description": "The footerc value"
},
"footerr": {
"type": "string",
"description": "The footerr value"
},
"footerishtml": {
"type": "boolean",
"description": "The footerishtml value"
},
"footerheight": {
"type": "integer",
"description": "The footerheight value"
},
"footerhtml": {
"type": "string",
"description": "The footerhtml value"
},
"colour": {
"type": "string",
"description": "The colour value"
},
"colour_type": {
"type": "integer",
"description": "Colour Type"
},
"backgroundimageurl": {
"type": "string",
"description": "The backgroundimageurl value"
},
"width": {
"type": "integer",
"description": "The width value"
},
"config_source_type": {
"type": "integer",
"description": "Config Source Type"
},
"config_url": {
"type": "string",
"description": "Config Url"
},
"reportingperiod": {
"type": "integer",
"description": "The reportingperiod value"
},
"system_use": {
"type": "string",
"description": "System Use"
},
"detailcolumns": {
"type": "array",
"items": {
"type": "object"
},
"description": "The detailcolumns value"
},
"pages": {
"type": "array",
"items": {
"type": "object"
},
"description": "The pages value"
},
"is_preview": {
"type": "boolean",
"description": "Is Preview"
},
"is_generate": {
"type": "boolean",
"description": "Is Generate"
},
"generate_entity_id": {
"type": "integer",
"description": "Generate Entity Id"
},
"printhtml": {
"type": "string",
"description": "The printhtml value"
},
"pdf_attachment_id": {
"type": "integer",
"description": "Pdf Attachment Id"
},
"pdf_attachment_link": {
"type": "string",
"description": "Pdf Attachment Link"
},
"quotation": {
"type": "object",
"description": "The quotation value"
},
"salesorder": {
"type": "object",
"description": "The salesorder value"
},
"purchaseorder": {
"type": "object",
"description": "The purchaseorder value"
},
"invoice": {
"type": "object",
"description": "The invoice value"
},
"contract": {
"type": "object",
"description": "The contract value"
},
"report": {
"type": "object",
"description": "Circular schema reference: #/components/schemas/AnalyzerProfile"
},
"consignment": {
"type": "object",
"description": "The consignment value"
},
"reports": {
"type": "array",
"items": {
"type": "object"
},
"description": "The reports value"
},
"composite_report_apid": {
"type": "integer",
"description": "Composite Report Apid"
},
"canbeaccessedbyallusers": {
"type": "boolean",
"description": "The canbeaccessedbyallusers value"
},
"permissions_user": {
"type": "array",
"items": {
"type": "object"
},
"description": "Permissions User"
},
"schedule": {
"type": "array",
"items": {
"type": "object"
},
"description": "The schedule value"
},
"clientid": {
"type": "integer",
"description": "The clientid value"
},
"licencename": {
"type": "string",
"description": "The licencename value"
},
"library_id": {
"type": "integer",
"description": "Library Id"
},
"image_attachment_id": {
"type": "integer",
"description": "Image Attachment Id"
},
"pagewidthinches": {
"type": "number",
"description": "The pagewidthinches value"
},
"pageheightinches": {
"type": "number",
"description": "The pageheightinches value"
},
"icon_base64": {
"type": "string",
"description": "Icon Base64"
},
"icon": {
"type": "string",
"description": "The icon value"
},
"kbentry": {
"type": "object",
"description": "The kbentry value"
},
"showinlineimage": {
"type": "boolean",
"description": "The showinlineimage value"
},
"pdf_media_type": {
"type": "integer",
"description": "Pdf Media Type"
},
"asset": {
"type": "object",
"description": "The asset value"
},
"prefix_pdf_attachment_id": {
"type": "integer",
"description": "Prefix Pdf Attachment Id"
},
"prefixpdfappend": {
"type": "boolean",
"description": "The prefixpdfappend value"
},
"iscustomised": {
"type": "boolean",
"description": "The iscustomised value"
},
"show_bundled_lines": {
"type": "integer",
"description": "Show Bundled Lines"
},
"_warning": {
"type": "string",
"description": "The warning value"
},
"_xmlwarning": {
"type": "string",
"description": "The xmlwarning value"
},
"override_attachment_name": {
"type": "string",
"description": "Override Attachment Name"
},
"portal_display_type": {
"type": "integer",
"description": "Portal Display Type"
},
"bulkprint_asset_id_list": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "Bulkprint Asset Id List"
},
"invoicexmltemplate": {
"type": "integer",
"description": "The invoicexmltemplate value"
},
"pdftinvoicexmltemplate_name": {
"type": "string",
"description": "Pdftinvoicexmltemplate Name"
},
"is_template_setup": {
"type": "boolean",
"description": "Is Template Setup"
},
"file_type": {
"type": "integer",
"description": "File Type"
},
"override_reportingperiod": {
"type": "integer",
"description": "Override Reportingperiod"
},
"access_control": {
"type": "array",
"items": {
"type": "object"
},
"description": "Access Control"
},
"access_control_level": {
"type": "integer",
"description": "Access Control Level"
}
}
},
"pdftemplate_id": {
"type": [
"integer",
"null"
],
"description": "Pdftemplate Id"
},
"pdftemplate_name": {
"type": [
"string",
"null"
],
"description": "Pdftemplate Name"
},
"permissions_agent": {
"type": "array",
"items": {
"type": "object",
"properties": {
"agent_id": {
"type": "integer",
"format": "int32",
"description": "Agent Id"
},
"agent_name": {
"type": "string",
"description": "Agent Name"
},
"report_id": {
"type": "integer",
"format": "int32",
"description": "Report Id"
},
"readonly": {
"type": "boolean",
"description": "The readonly value"
}
}
},
"description": "Permissions Agent"
},
"permissions_user": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "The id value"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User Id"
},
"user_name": {
"type": "string",
"description": "User Name"
},
"report_id": {
"type": "integer",
"format": "int32",
"description": "Report Id"
},
"client_id": {
"type": "integer",
"format": "int32",
"description": "Client Id"
},
"client_name": {
"type": "string",
"description": "Client Name"
},
"site_id": {
"type": "integer",
"format": "int32",
"description": "Site Id"
},
"site_name": {
"type": "string",
"description": "Site Name"
},
"role_id": {
"type": "integer",
"format": "int32",
"description": "Role Id"
},
"role_name": {
"type": "string",
"description": "Role Name"
},
"type": {
"type": "string",
"description": "The type value"
},
"allow_everyone": {
"type": "boolean",
"description": "Allow Everyone"
},
"department_id": {
"type": "integer",
"format": "int32",
"description": "Department Id"
},
"department_name": {
"type": "string",
"description": "Department Name"
},
"organisation_id": {
"type": "integer",
"format": "int32",
"description": "Organisation Id"
},
"organisation_name": {
"type": "string",
"description": "Organisation Name"
}
}
},
"description": "Permissions User"
},
"previous_report": {
"type": "object",
"description": "Previous Report",
"properties": {
"loaded": {
"type": "boolean",
"description": "The loaded value"
},
"load_error": {
"type": "string",
"description": "Load Error"
},
"rows": {
"type": "array",
"items": {
"type": "object"
},
"description": "The rows value"
},
"chart_labels": {
"type": "array",
"description": "Chart Labels"
},
"chart_dataset": {
"type": "array",
"description": "Chart Dataset"
},
"chart_dataset1": {
"type": "array",
"description": "Chart Dataset1"
},
"chart_dataset2": {
"type": "array",
"description": "Chart Dataset2"
},
"chart_dataset3": {
"type": "array",
"description": "Chart Dataset3"
},
"chart_dataset4": {
"type": "array",
"description": "Chart Dataset4"
},
"chart_dataset5": {
"type": "array",
"description": "Chart Dataset5"
},
"base_link": {
"type": "string",
"description": "Base Link"
},
"table_html": {
"type": "string",
"description": "Table Html"
},
"datasets": {
"type": "object",
"description": "The datasets value"
},
"counter_value": {
"type": "number",
"description": "Counter Value"
},
"forecast_output": {
"type": "array",
"items": {
"type": "object"
},
"description": "Forecast Output"
},
"forecast_run_date": {
"type": "string",
"description": "Forecast Run Date"
},
"chart_has_forecast_dataset": {
"type": "boolean",
"description": "Chart Has Forecast Dataset"
}
}
},
"printhtml": {
"type": [
"string",
"null"
],
"description": "The printhtml value"
},
"publish_type": {
"type": [
"integer",
"null"
],
"description": "Publish Type"
},
"published_id": {
"type": [
"string",
"null"
],
"description": "Published Id"
},
"purchase_order_id": {
"type": [
"integer",
"null"
],
"description": "Purchase Order Id"
},
"quote_id": {
"type": [
"integer",
"null"
],
"description": "Quote Id"
},
"report": {
"type": "object",
"description": "The report value",
"properties": {
"loaded": {
"type": "boolean",
"description": "The loaded value"
},
"load_error": {
"type": "string",
"description": "Load Error"
},
"rows": {
"type": "array",
"items": {
"type": "object"
},
"description": "The rows value"
},
"chart_labels": {
"type": "array",
"description": "Chart Labels"
},
"chart_dataset": {
"type": "array",
"description": "Chart Dataset"
},
"chart_dataset1": {
"type": "array",
"description": "Chart Dataset1"
},
"chart_dataset2": {
"type": "array",
"description": "Chart Dataset2"
},
"chart_dataset3": {
"type": "array",
"description": "Chart Dataset3"
},
"chart_dataset4": {
"type": "array",
"description": "Chart Dataset4"
},
"chart_dataset5": {
"type": "array",
"description": "Chart Dataset5"
},
"base_link": {
"type": "string",
"description": "Base Link"
},
"table_html": {
"type": "string",
"description": "Table Html"
},
"datasets": {
"type": "object",
"description": "The datasets value"
},
"counter_value": {
"type": "number",
"description": "Counter Value"
},
"forecast_output": {
"type": "array",
"items": {
"type": "object"
},
"description": "Forecast Output"
},
"forecast_run_date": {
"type": "string",
"description": "Forecast Run Date"
},
"chart_has_forecast_dataset": {
"type": "boolean",
"description": "Chart Has Forecast Dataset"
}
}
},
"report_access_token": {
"type": [
"string",
"null"
],
"description": "Report Access Token"
},
"report_comparison": {
"type": [
"integer",
"null"
],
"description": "Report Comparison"
},
"report_table_autosize_width": {
"type": [
"boolean",
"null"
],
"description": "Report Table Autosize Width"
},
"report_table_group_html": {
"type": [
"string",
"null"
],
"description": "Report Table Group Html"
},
"report_table_html": {
"type": [
"string",
"null"
],
"description": "Report Table Html"
},
"report_table_row_html": {
"type": [
"string",
"null"
],
"description": "Report Table Row Html"
},
"report_table_total_html": {
"type": [
"string",
"null"
],
"description": "Report Table Total Html"
},
"reporting_period_date_only": {
"type": [
"boolean",
"null"
],
"description": "Reporting Period Date Only"
},
"reportingperiod": {
"type": [
"integer",
"null"
],
"description": "The reportingperiod value"
},
"reportingperioddatefield": {
"type": [
"string",
"null"
],
"description": "The reportingperioddatefield value"
},
"reportingperiodenddate": {
"type": [
"string",
"null"
],
"description": "The reportingperiodenddate value"
},
"reportingperiodstartdate": {
"type": [
"string",
"null"
],
"description": "The reportingperiodstartdate value"
},
"reports": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"name": {
"type": "string",
"description": "The name value"
}
}
},
"description": "The reports value"
},
"restrictaccess": {
"type": [
"boolean",
"null"
],
"description": "The restrictaccess value"
},
"run_ai_analysis_before_schedule": {
"type": [
"boolean",
"null"
],
"description": "Run Ai Analysis Before Schedule"
},
"sales_order_id": {
"type": [
"integer",
"null"
],
"description": "Sales Order Id"
},
"schedule": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "The id value"
},
"guid": {
"type": "string",
"format": "uuid",
"description": "The guid value"
},
"intent": {
"type": "string",
"description": "The intent value"
},
"name": {
"type": "string",
"description": "The name value"
},
"type": {
"type": "integer",
"format": "int32",
"description": "The type value"
},
"domain": {
"type": "string",
"description": "The domain value"
},
"group_id": {
"type": "integer",
"format": "int32",
"description": "Group Id"
},
"restriction_type": {
"type": "string",
"description": "Restriction Type"
},
"restrictto_department_id": {
"type": "integer",
"format": "int32",
"description": "Restrictto Department Id"
},
"restrictto_department_name": {
"type": "string",
"description": "Restrictto Department Name"
},
"restrictto_team_id": {
"type": "integer",
"format": "int32",
"description": "Restrictto Team Id"
},
"restrictto_team_name": {
"type": "string",
"description": "Restrictto Team Name"
},
"restrictto_agent_id": {
"type": "integer",
"format": "int32",
"description": "Restrictto Agent Id"
},
"restrictto_agent_name": {
"type": "string",
"description": "Restrictto Agent Name"
},
"summary": {
"type": "string",
"description": "The summary value"
},
"tickettype_id": {
"type": "integer",
"format": "int32",
"description": "Tickettype Id"
},
"rule_count": {
"type": "integer",
"format": "int32",
"description": "Rule Count"
},
"creation_rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"parent_template_id": {
"type": "integer"
},
"child_template_id": {
"type": "integer"
},
"parent_template_guid": {
"type": "string"
},
"child_template_guid": {
"type": "string"
},
"usage": {
"type": "integer"
},
"rule_type": {
"type": "integer"
},
"createonchildclose_id": {
"type": "integer"
},
"createonchildclose_guid": {
"type": "string"
},
"createonchildclose_name": {
"type": "string"
},
"working_days": {
"type": "integer"
},
"outcome_id": {
"type": "integer"
},
"outcome_guid": {
"type": "string"
},
"outcome_name": {
"type": "string"
},
"field_id": {
"type": "integer"
},
"field_guid": {
"type": "string"
},
"field_value": {
"type": "integer"
},
"field_value_string": {
"type": "string"
},
"field_contains": {
"type": "string"
},
"field_name": {
"type": "string"
},
"approvalstatus": {
"type": "integer"
},
"group_id": {
"type": "integer"
},
"optionalservice_id": {
"type": "integer"
},
"tickettype_id": {
"type": "integer"
},
"_warning": {
"type": "string"
}
}
},
"description": "Creation Rules"
},
"todo_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"template_id": {
"type": "integer"
},
"id": {
"type": "integer"
},
"text": {
"type": "string"
},
"sequence": {
"type": "integer"
},
"allowed_clients": {
"type": "array"
},
"group_id": {
"type": "integer"
},
"group": {
"type": "object"
},
"group_name": {
"type": "string"
},
"group_seq": {
"type": "integer"
},
"_warning": {
"type": "string"
}
}
},
"description": "Todo List"
},
"emailto": {
"type": "string",
"description": "The emailto value"
},
"emailcc": {
"type": "string",
"description": "The emailcc value"
},
"emailbcc": {
"type": "string",
"description": "The emailbcc value"
},
"emailsubject": {
"type": "string",
"description": "The emailsubject value"
},
"time": {
"type": "string",
"format": "date-time",
"description": "The time value"
},
"disabled": {
"type": "boolean",
"description": "The disabled value"
},
"lastcreated": {
"type": "string",
"format": "date-time",
"description": "The lastcreated value"
},
"nextcreationdate": {
"type": "string",
"format": "date-time",
"description": "The nextcreationdate value"
},
"nextcreationdate_after_end": {
"type": "string",
"format": "date-time",
"description": "Nextcreationdate After End"
},
"execution_type": {
"type": "integer",
"format": "int32",
"description": "Execution Type"
},
"startdate": {
"type": "string",
"format": "date-time",
"description": "Start date for filtering"
},
"end_date": {
"type": "string",
"format": "date-time",
"description": "End date for filtering"
},
"period": {
"type": "integer",
"format": "int32",
"description": "The period value"
},
"create_locked": {
"type": "boolean",
"description": "Create Locked"
},
"one_ticket_id": {
"type": "integer",
"format": "int32",
"description": "One Ticket Id"
},
"created_ticket_id": {
"type": "integer",
"format": "int32",
"description": "Created Ticket Id"
},
"approval_id": {
"type": "integer",
"format": "int32",
"description": "Approval Id"
},
"reportarea": {
"type": "integer",
"format": "int32",
"description": "The reportarea value"
},
"reportarea_name": {
"type": "string",
"description": "Reportarea Name"
},
"restrictto_department_guid": {
"type": "string",
"format": "uuid",
"description": "Restrictto Department Guid"
},
"restrictto_team_guid": {
"type": "string",
"format": "uuid",
"description": "Restrictto Team Guid"
},
"clients": {
"type": "string",
"description": "The clients value"
},
"tickettype_guid": {
"type": "string",
"format": "uuid",
"description": "Tickettype Guid"
},
"automationtype": {
"type": "integer",
"format": "int32",
"description": "The automationtype value"
},
"optionalservice": {
"type": "integer",
"format": "int32",
"description": "The optionalservice value"
},
"optional_agent_id": {
"type": "integer",
"format": "int32",
"description": "Optional Agent Id"
},
"optional_team": {
"type": "string",
"description": "Optional Team"
},
"optional_status_id": {
"type": "integer",
"format": "int32",
"description": "Optional Status Id"
},
"optional_tickettype_id": {
"type": "integer",
"format": "int32",
"description": "Optional Tickettype Id"
},
"optional_create_locked": {
"type": "boolean",
"description": "Optional Create Locked"
},
"optional_defaultresourcetype": {
"type": "integer",
"format": "int32",
"description": "Optional Defaultresourcetype"
},
"optional_excludefromsla": {
"type": "integer",
"format": "int32",
"description": "Optional Excludefromsla"
},
"optional_customfields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"label": {
"type": "string"
},
"summary": {
"type": "string"
},
"type": {
"type": "integer"
},
"value": {},
"value_is_password_id": {
"type": "boolean"
},
"display": {
"type": "string"
},
"characterlimit": {
"type": "integer"
},
"characterlimittype": {
"type": "integer"
},
"inputtype": {
"type": "integer"
},
"copytochild": {
"type": "boolean"
},
"copytoparent": {
"type": "boolean"
},
"searchable": {
"type": "boolean"
},
"ordervalues": {
"type": "boolean"
},
"ordervaluesby": {
"type": "integer"
},
"database_lookup_id": {
"type": "integer"
},
"database_lookup_auto": {
"type": "boolean"
},
"database_lookup_triggers": {
"type": "array"
},
"third_party_name": {
"type": "string"
},
"extratype": {
"type": "integer"
},
"copytochildonupdate": {
"type": "boolean"
},
"copytograndchildonupdate": {
"type": "boolean"
},
"copytoparentonupdate": {
"type": "boolean"
},
"hyperlink": {
"type": "string"
},
"usage": {
"type": "integer"
},
"linked_table_id": {
"type": "integer"
},
"showondetailsscreen": {
"type": "boolean"
},
"third_party_value": {
"type": "string"
},
"custom_extra_table_id": {
"type": "integer"
},
"copytorelated": {
"type": "boolean"
},
"only_validate_on_creation": {
"type": "boolean"
},
"calculation": {
"type": "string"
},
"rounding": {
"type": "integer"
},
"validation_reasons": {
"type": "array"
},
"int_value_is_display": {
"type": "boolean"
},
"regex": {
"type": "string"
},
"onlyshowforagents": {
"type": "boolean"
},
"is_horizontal": {
"type": "boolean"
},
"copied": {
"type": "boolean"
},
"isencrypted": {
"type": "boolean"
},
"max_selection": {
"type": "integer"
},
"guid": {
"type": "string"
},
"selection_field_id": {
"type": "integer"
},
"variable_format_1": {
"type": "string"
},
"variable_format_2": {
"type": "string"
},
"validation_data": {
"type": "array"
},
"database_lookup_input": {
"type": "integer"
},
"table_data_entry_type": {
"type": "integer"
},
"showintable": {
"type": "boolean"
},
"table_height": {
"type": "integer"
},
"dont_delete_rows": {
"type": "boolean"
},
"table_matching_field": {
"type": "integer"
},
"new_storage_method": {
"type": "boolean"
},
"where_sql": {
"type": "string"
},
"load_type": {
"type": "integer"
},
"add_rows": {
"type": "boolean"
},
"delete_these_rows": {
"type": "array"
},
"showinpool": {
"type": "boolean"
},
"allow_pool_override": {
"type": "boolean"
},
"details_column_group": {
"type": "integer"
},
"add_row_per_value": {
"type": "boolean"
},
"store_in_fielddata": {
"type": "boolean"
},
"first_value_default": {
"type": "boolean"
},
"copytoparentnewticket": {
"type": "boolean"
}
}
},
"description": "Optional Customfields"
},
"optional_assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"changeguid": {
"type": "string"
},
"intent": {
"type": "string"
},
"inventory_number": {
"type": "string"
},
"key_field": {
"type": "string"
},
"key_field2": {
"type": "string"
},
"key_field3": {
"type": "string"
},
"client_id": {
"type": "integer"
},
"client_name": {
"type": "string"
},
"site_id": {
"type": "integer"
},
"site_name": {
"type": "string"
},
"business_owner_id": {
"type": "integer"
},
"business_owner_name": {
"type": "string"
},
"business_owner_site": {
"type": "string"
},
"business_owner_client": {
"type": "string"
},
"business_owner_cab_id": {
"type": "integer"
},
"business_owner_cab_name": {
"type": "string"
},
"username": {
"type": "string"
},
"technical_owner_id": {
"type": "integer"
},
"technical_owner_name": {
"type": "string"
},
"technical_owner_cab_id": {
"type": "integer"
},
"technical_owner_cab_name": {
"type": "string"
},
"intune_default_site": {
"type": "integer"
},
"assettype_id": {
"type": "integer"
},
"assettype_name": {
"type": "string"
},
"colour": {
"type": "string"
},
"icon": {
"type": "string"
},
"warranty_end": {
"type": "string"
},
"inactive": {
"type": "boolean"
},
"is_primary_asset": {
"type": "boolean"
},
"parent_id": {
"type": "integer"
},
"lansweeper_parent_id": {
"type": "string"
},
"child_id": {
"type": "integer"
},
"sibling_id": {
"type": "boolean"
},
"contract_value": {
"type": "number"
},
"contract_ref": {
"type": "string"
},
"contract_id": {
"type": "integer"
},
"supplier_id": {
"type": "integer"
},
"supplier_name": {
"type": "string"
},
"manufacturer_id": {
"type": "integer"
},
"manufacturer_name": {
"type": "string"
},
"supplier_contract_id": {
"type": "integer"
},
"supplier_contract_ref": {
"type": "string"
},
"supplier_sla_id": {
"type": "integer"
},
"supplier_priority_id": {
"type": "integer"
},
"fields": {
"type": "array"
},
"customfields": {
"type": "array"
},
"relationship_id": {
"type": "integer"
},
"default_contract_value": {
"type": "number"
},
"itemstock_id": {
"type": "integer"
},
"item_id": {
"type": "integer"
},
"stock_date": {
"type": "string"
},
"non_consignable": {
"type": "boolean"
},
"reserved_salesorder_id": {
"type": "integer"
},
"reserved_salesorder_line_id": {
"type": "integer"
},
"matching_field": {
"type": "string"
},
"is_auto_picking_asset_tag": {
"type": "boolean"
},
"device42_id": {
"type": "integer"
},
"device42_url": {
"type": "string"
},
"related_services": {
"type": "string"
},
"technical_owner": {
"type": "string"
},
"business_owner": {
"type": "string"
},
"primary_asset_chart_json": {
"type": "string"
},
"criticality": {
"type": "integer"
},
"service_id": {
"type": "integer"
},
"key": {
"type": "integer"
},
"table": {
"type": "integer"
},
"use": {
"type": "string"
},
"device_number": {
"type": "integer"
},
"assettype_guid": {
"type": "string"
},
"owning_portfolio_name": {
"type": "string"
},
"owning_service_name": {
"type": "string"
},
"owning_businessapp_name": {
"type": "string"
},
"owning_ci_name": {
"type": "string"
},
"warranty_start": {
"type": "string"
},
"labour_warranty_start": {
"type": "string"
},
"labour_warranty_end": {
"type": "string"
},
"parent_guid": {
"type": "string"
},
"child_guid": {
"type": "string"
},
"status_id": {
"type": "integer"
},
"status_name": {
"type": "string"
},
"third_party_id": {
"type": "integer"
},
"sla_name": {
"type": "string"
},
"priority_name": {
"type": "string"
},
"latest_contract_ref": {
"type": "string"
},
"sequence": {
"type": "integer"
},
"ncentral_url": {
"type": "string"
},
"ncentral_remote_url": {
"type": "string"
},
"contract_end_date": {
"type": "string"
},
"atera_id": {
"type": "string"
},
"automate_id": {
"type": "integer"
},
"automate_url": {
"type": "string"
},
"connectwise_control_url": {
"type": "string"
},
"ninjarmm_id": {
"type": "integer"
},
"ninja_url": {
"type": "string"
},
"ninja_remote_url": {
"type": "string"
},
"syncro_url": {
"type": "string"
},
"syncroid": {
"type": "integer"
},
"itglue_url": {
"type": "string"
},
"defaultsequence": {
"type": "integer"
},
"service_ids": {
"type": "string"
},
"bulkcreated": {
"type": "boolean"
},
"bulkbillingperiod": {
"type": "integer"
},
"asset_field": {
"type": "string"
},
"datto_alternate_id": {
"type": "integer"
},
"syncro_id": {
"type": "string"
},
"domotz_id": {
"type": "string"
},
"snow_id": {
"type": "integer"
},
"passportal_id": {
"type": "integer"
},
"auvik_device_id": {
"type": "string"
},
"auvik_url": {
"type": "string"
},
"allowallstatus": {
"type": "boolean"
},
"allowed_status": {
"type": "array"
},
"allowallcustombuttons": {
"type": "boolean"
},
"allowed_custombuttons": {
"type": "array"
},
"datto_id": {
"type": "string"
},
"addigy_id": {
"type": "string"
},
"liongard_url": {
"type": "string"
},
"liongard_environmnet_id": {
"type": "integer"
},
"liongard_id": {
"type": "string"
},
"kaseya_id": {
"type": "string"
},
"iskaseyaagent": {
"type": "boolean"
},
"kaseyavsa_url": {
"type": "string"
},
"addigy_url": {
"type": "string"
},
"teamviewerid": {
"type": "string"
},
"serialization_user": {
"type": "integer"
},
"zabbix_id": {
"type": "string"
},
"zabbix_url": {
"type": "string"
},
"stockbin_name": {
"type": "string"
},
"issue_consignment_line_id": {
"type": "integer"
},
"item_name": {
"type": "string"
},
"datto_url": {
"type": "string"
},
"ncentral_details_id": {
"type": "integer"
},
"nable_id": {
"type": "string"
},
"connectwisecontrolid": {
"type": "string"
},
"_isimport": {
"type": "boolean"
},
"_importtype": {
"type": "string"
},
"workspace_id": {
"type": "string"
},
"workspace_url": {
"type": "string"
},
"intune_id": {
"type": "string"
},
"supplier_purchasedate": {
"type": "string"
},
"logicmonitor_id": {
"type": "string"
},
"barracudarmm_id": {
"type": "string"
},
"sla_id": {
"type": "integer"
},
"priority_id": {
"type": "integer"
},
"icinga_id": {
"type": "string"
},
"related_service_name": {
"type": "string"
},
"related_service_count": {
"type": "integer"
},
"connectwisermm_id": {
"type": "string"
},
"xensam_id": {
"type": "string"
},
"asset_type_priority": {
"type": "integer"
},
"snipeit_id": {
"type": "string"
},
"prometheus_id": {
"type": "string"
},
"dynatrace_id": {
"type": "string"
},
"vmworkspace_id": {
"type": "string"
},
"tanium_id": {
"type": "string"
},
"tenable_id": {
"type": "string"
},
"kandji_id": {
"type": "string"
},
"criticality_description": {
"type": "string"
},
"auvik_id": {
"type": "string"
},
"is_template": {
"type": "boolean"
},
"aws_id": {
"type": "string"
},
"manageengine_id": {
"type": "string"
},
"manageengine_customer_id": {
"type": "string"
},
"lastchangeofvaluedate": {
"type": "string"
},
"commissiondate": {
"type": "string"
},
"first_user_id": {
"type": "integer"
},
"changebackupexists": {
"type": "boolean"
},
"_isbatch": {
"type": "boolean"
},
"virima_id": {
"type": "string"
},
"service_guid": {
"type": "string"
},
"service_name": {
"type": "string"
},
"lansweeperid": {
"type": "string"
},
"eracent_id": {
"type": "string"
},
"changehistory_last_updated": {
"type": "string"
},
"changehistory_updated_by": {
"type": "string"
},
"changehistory_created_by": {
"type": "string"
},
"changehistory_created_date": {
"type": "string"
},
"auto_link": {
"type": "boolean"
},
"impact_statement": {
"type": "string"
},
"activity_statement": {
"type": "string"
},
"raynet_id": {
"type": "string"
},
"armis_id": {
"type": "string"
},
"kaseyavsax_id": {
"type": "string"
},
"diagram_field1": {
"type": "string"
},
"diagram_field2": {
"type": "string"
},
"diagram_field3": {
"type": "string"
},
"ci_type": {
"type": "integer"
},
"manually_linked_ticket": {
"type": "boolean"
},
"_importtypeid": {
"type": "integer"
},
"_importthirdpartyid": {
"type": "string"
},
"new_external_link": {
"type": "object"
},
"import_details_id": {
"type": "integer"
},
"_isupdateimport": {
"type": "boolean"
},
"_match_thirdparty_id": {
"type": "string"
},
"_match_integration_id": {
"type": "integer"
},
"_match_integration_name": {
"type": "string"
},
"_match_integration_button_caption": {
"type": "string"
},
"_match_integration_button_url": {
"type": "string"
},
"_match_integration_button_icon": {
"type": "string"
}
}
},
"description": "Optional Assets"
},
"optional_forwardinboundupdates": {
"type": "integer",
"format": "int32",
"description": "Optional Forwardinboundupdates"
},
"optional_showforusers": {
"type": "integer",
"format": "int32",
"description": "Optional Showforusers"
},
"optional_urgency": {
"type": "integer",
"format": "int32",
"description": "Optional Urgency"
},
"optional_impact": {
"type": "integer",
"format": "int32",
"description": "Optional Impact"
},
"optional_workflow_id": {
"type": "integer",
"format": "int32",
"description": "Optional Workflow Id"
},
"optional_estimate": {
"type": "number",
"format": "double",
"description": "Optional Estimate"
},
"optional_category_1": {
"type": "string",
"description": "Optional Category 1"
},
"optional_category_2": {
"type": "string",
"description": "Optional Category 2"
},
"optional_category_3": {
"type": "string",
"description": "Optional Category 3"
},
"optional_category_4": {
"type": "string",
"description": "Optional Category 4"
},
"optional_priority_id": {
"type": "integer",
"format": "int32",
"description": "Optional Priority Id"
},
"optional_budgettype_id": {
"type": "integer",
"format": "int32",
"description": "Optional Budgettype Id"
},
"optional_kb_id": {
"type": "integer",
"format": "int32",
"description": "Optional Kb Id"
},
"optional_service": {
"type": "integer",
"format": "int32",
"description": "Optional Service"
},
"optional_service_details_id": {
"type": "integer",
"format": "int32",
"description": "Optional Service Details Id"
},
"service": {
"type": "integer",
"format": "int32",
"description": "The service value"
},
"optional_sla_id": {
"type": "integer",
"format": "int32",
"description": "Optional Sla Id"
},
"parent_customfields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"template_id": {
"type": "integer"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"value": {}
}
},
"description": "Parent Customfields"
}
}
},
"description": "The schedule value"
},
"selectedfields": {
"type": [
"string",
"null"
],
"description": "The selectedfields value"
},
"series": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "The id value"
},
"report_id": {
"type": "integer",
"format": "int32",
"description": "Report Id"
},
"report_name": {
"type": "string",
"description": "Report Name"
},
"widget_id": {
"type": "integer",
"format": "int32",
"description": "Widget Id"
},
"seriestype": {
"type": "integer",
"format": "int32",
"description": "The seriestype value"
},
"yaxis": {
"type": "string",
"description": "The yaxis value"
},
"seq": {
"type": "integer",
"format": "int32",
"description": "The seq value"
},
"_warning": {
"type": "string",
"description": "The warning value"
}
}
},
"description": "The series value"
},
"seriestype1": {
"type": [
"integer",
"null"
],
"description": "The seriestype1 value"
},
"seriestype2": {
"type": [
"integer",
"null"
],
"description": "The seriestype2 value"
},
"seriestype3": {
"type": [
"integer",
"null"
],
"description": "The seriestype3 value"
},
"seriestype4": {
"type": [
"integer",
"null"
],
"description": "The seriestype4 value"
},
"seriestype5": {
"type": [
"integer",
"null"
],
"description": "The seriestype5 value"
},
"show_datavalues": {
"type": [
"boolean",
"null"
],
"description": "Show Datavalues"
},
"show_forecast_chart": {
"type": [
"boolean",
"null"
],
"description": "Show Forecast Chart"
},
"show_forecast_table": {
"type": [
"boolean",
"null"
],
"description": "Show Forecast Table"
},
"show_top_only": {
"type": [
"boolean",
"null"
],
"description": "Show Top Only"
},
"show_trendline": {
"type": [
"boolean",
"null"
],
"description": "Show Trendline"
},
"showgraphvalues": {
"type": [
"boolean",
"null"
],
"description": "The showgraphvalues value"
},
"sql": {
"type": [
"string",
"null"
],
"description": "The sql value"
},
"sqlhasdatefilter": {
"type": [
"boolean",
"null"
],
"description": "The sqlhasdatefilter value"
},
"sqlid": {
"type": [
"integer",
"null"
],
"description": "The sqlid value"
},
"stackbars": {
"type": [
"boolean",
"null"
],
"description": "The stackbars value"
},
"sum": {
"type": [
"boolean",
"null"
],
"description": "The sum value"
},
"systemreportid": {
"type": [
"integer",
"null"
],
"description": "The systemreportid value"
},
"ticket_id": {
"type": [
"integer",
"null"
],
"description": "Ticket Id"
},
"timezonename": {
"type": [
"string",
"null"
],
"description": "The timezonename value"
},
"top_count": {
"type": [
"integer",
"null"
],
"description": "Top Count"
},
"type": {
"type": [
"integer",
"null"
],
"description": "The type value"
},
"usesdynamicsql": {
"type": [
"boolean",
"null"
],
"description": "The usesdynamicsql value"
},
"usetechlink": {
"type": [
"boolean",
"null"
],
"description": "The usetechlink value"
},
"xaxis": {
"type": [
"string",
"null"
],
"description": "The xaxis value"
},
"xaxiscaption": {
"type": [
"string",
"null"
],
"description": "The xaxiscaption value"
},
"xls_attachment_id": {
"type": [
"integer",
"null"
],
"description": "Xls Attachment Id"
},
"xls_attachment_link": {
"type": [
"string",
"null"
],
"description": "Xls Attachment Link"
},
"yaxis": {
"type": [
"string",
"null"
],
"description": "The yaxis value"
},
"yaxis1": {
"type": [
"string",
"null"
],
"description": "The yaxis1 value"
},
"yaxis2": {
"type": [
"string",
"null"
],
"description": "The yaxis2 value"
},
"yaxis3": {
"type": [
"string",
"null"
],
"description": "The yaxis3 value"
},
"yaxis4": {
"type": [
"string",
"null"
],
"description": "The yaxis4 value"
},
"yaxis5": {
"type": [
"string",
"null"
],
"description": "The yaxis5 value"
},
"yaxiscaption": {
"type": [
"string",
"null"
],
"description": "The yaxiscaption value"
}
},
"required": [
"PCID"
]
}
```
***
## haloitsm\_knowledge\_create\_feedback
POST /Feedback
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | ------------ |
| `body` | object\[] | No | — | Request body |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"body": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "The id value"
},
"ticket_id": {
"type": "integer",
"format": "int32",
"description": "Ticket Id"
},
"key": {
"type": "string",
"description": "The key value"
},
"score": {
"type": "integer",
"format": "int32",
"description": "The score value"
},
"date": {
"type": "string",
"format": "date-time",
"description": "The date value"
},
"comment": {
"type": "string",
"description": "The comment value"
},
"score_band": {
"type": "integer",
"format": "int32",
"description": "Score Band"
},
"user_message": {
"type": "string",
"description": "User Message"
},
"customsurveyfields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"label": {
"type": "string"
},
"summary": {
"type": "string"
},
"type": {
"type": "integer"
},
"value": {},
"value_is_password_id": {
"type": "boolean"
},
"display": {
"type": "string"
},
"characterlimit": {
"type": "integer"
},
"characterlimittype": {
"type": "integer"
},
"inputtype": {
"type": "integer"
},
"copytochild": {
"type": "boolean"
},
"copytoparent": {
"type": "boolean"
},
"searchable": {
"type": "boolean"
},
"ordervalues": {
"type": "boolean"
},
"ordervaluesby": {
"type": "integer"
},
"database_lookup_id": {
"type": "integer"
},
"database_lookup_auto": {
"type": "boolean"
},
"database_lookup_triggers": {
"type": "array"
},
"third_party_name": {
"type": "string"
},
"extratype": {
"type": "integer"
},
"copytochildonupdate": {
"type": "boolean"
},
"copytograndchildonupdate": {
"type": "boolean"
},
"copytoparentonupdate": {
"type": "boolean"
},
"hyperlink": {
"type": "string"
},
"usage": {
"type": "integer"
},
"linked_table_id": {
"type": "integer"
},
"showondetailsscreen": {
"type": "boolean"
},
"third_party_value": {
"type": "string"
},
"custom_extra_table_id": {
"type": "integer"
},
"copytorelated": {
"type": "boolean"
},
"only_validate_on_creation": {
"type": "boolean"
},
"calculation": {
"type": "string"
},
"rounding": {
"type": "integer"
},
"validation_reasons": {
"type": "array"
},
"int_value_is_display": {
"type": "boolean"
},
"regex": {
"type": "string"
},
"onlyshowforagents": {
"type": "boolean"
},
"is_horizontal": {
"type": "boolean"
},
"copied": {
"type": "boolean"
},
"isencrypted": {
"type": "boolean"
},
"max_selection": {
"type": "integer"
},
"guid": {
"type": "string"
},
"selection_field_id": {
"type": "integer"
},
"variable_format_1": {
"type": "string"
},
"variable_format_2": {
"type": "string"
},
"validation_data": {
"type": "array"
},
"database_lookup_input": {
"type": "integer"
},
"table_data_entry_type": {
"type": "integer"
},
"showintable": {
"type": "boolean"
},
"table_height": {
"type": "integer"
},
"dont_delete_rows": {
"type": "boolean"
},
"table_matching_field": {
"type": "integer"
},
"new_storage_method": {
"type": "boolean"
},
"where_sql": {
"type": "string"
},
"load_type": {
"type": "integer"
},
"add_rows": {
"type": "boolean"
},
"delete_these_rows": {
"type": "array"
},
"showinpool": {
"type": "boolean"
},
"allow_pool_override": {
"type": "boolean"
},
"details_column_group": {
"type": "integer"
},
"add_row_per_value": {
"type": "boolean"
},
"store_in_fielddata": {
"type": "boolean"
},
"first_value_default": {
"type": "boolean"
},
"copytoparentnewticket": {
"type": "boolean"
}
}
},
"description": "The customsurveyfields value"
},
"recaptcha_token": {
"type": "string",
"description": "Recaptcha Token"
},
"feedback_faultid": {
"type": "integer",
"format": "int32",
"description": "Feedback Faultid"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"copytochildonupdate": {
"type": "boolean"
},
"id": {
"type": "integer"
},
"rtid": {
"type": "integer"
},
"usage": {
"type": "integer"
},
"fieldid": {
"type": "integer"
},
"fieldguid": {
"type": "string"
},
"seq": {
"type": "integer"
},
"tableid": {
"type": "integer"
},
"tableguid": {
"type": "string"
},
"groupid": {
"type": "integer"
},
"groupguid": {
"type": "string"
},
"endusernew": {
"type": "integer"
},
"enduserdetail": {
"type": "integer"
},
"enduserdetailrejected": {
"type": "integer"
},
"technew": {
"type": "integer"
},
"techdetail": {
"type": "integer"
},
"fieldname": {
"type": "string"
},
"fieldinfo": {
"type": "object"
},
"visibility_conditions": {
"type": "array"
},
"visibility_conditions_value": {
"type": "array"
},
"group_visibility_conditions": {
"type": "array"
},
"value_restrictions": {
"type": "array"
},
"group": {
"type": "object"
},
"technewlocation": {
"type": "integer"
},
"restrictupdate": {
"type": "integer"
},
"update_restrictions": {
"type": "array"
},
"techtab_id": {
"type": "integer"
},
"techtab_name": {
"type": "string"
},
"showdependency": {
"type": "boolean"
},
"canupdate": {
"type": "boolean"
},
"_warning": {
"type": "string"
},
"override_fieldname": {
"type": "string"
},
"override_action_fieldname": {
"type": "string"
},
"boldlabelandvalue": {
"type": "boolean"
},
"enduserdetailhideifempty": {
"type": "boolean"
},
"techdetailhideifempty": {
"type": "boolean"
},
"copytochild": {
"type": "boolean"
},
"copytorelated": {
"type": "boolean"
},
"restrictread": {
"type": "integer"
},
"read_restrictions": {
"type": "array"
},
"techtab_columns": {
"type": "integer"
},
"chat_message": {
"type": "string"
},
"techaction": {
"type": "integer"
},
"enduseraction": {
"type": "integer"
},
"endusercheckboxmandatory": {
"type": "boolean"
},
"translations": {
"type": "array"
},
"display_type": {
"type": "integer"
},
"copytoparent": {
"type": "boolean"
},
"copytoparentonupdate": {
"type": "boolean"
},
"agentcheckboxmandatory": {
"type": "boolean"
},
"agentbookingdetail": {
"type": "integer"
},
"copytoparentnewticket": {
"type": "boolean"
}
}
},
"description": "The fields value"
},
"automation_id": {
"type": "integer",
"format": "int32",
"description": "Automation Id"
},
"is_survey": {
"type": "boolean",
"description": "Is Survey"
},
"_warning": {
"type": "string",
"description": "The warning value"
},
"_error": {
"type": "string",
"description": "The error value"
},
"ip_address": {
"type": "string",
"description": "Ip Address"
},
"_dont_fire_automations": {
"type": "boolean",
"description": "Dont Fire Automations"
}
}
},
"description": "Request body"
}
},
"required": [
"PCID"
]
}
```
***
## haloitsm\_knowledge\_create\_kbarticle
POST /KBArticle
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | ------------ |
| `body` | object\[] | No | — | Request body |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"body": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "The id value"
},
"name": {
"type": "string",
"description": "The name value"
},
"description": {
"type": "string",
"description": "The description value"
},
"view_count": {
"type": "integer",
"format": "int32",
"description": "View Count"
},
"useful_count": {
"type": "integer",
"format": "int32",
"description": "Useful Count"
},
"notuseful_count": {
"type": "integer",
"format": "int32",
"description": "Notuseful Count"
},
"date_created": {
"type": "string",
"format": "date-time",
"description": "Date Created"
},
"date_edited": {
"type": "string",
"format": "date-time",
"description": "Date Edited"
},
"tag_string": {
"type": "string",
"description": "Tag String"
},
"inactive": {
"type": "boolean",
"description": "The inactive value"
},
"type": {
"type": "integer",
"format": "int32",
"description": "The type value"
},
"next_review_date": {
"type": "string",
"format": "date-time",
"description": "Next Review Date"
},
"customfields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"label": {
"type": "string"
},
"summary": {
"type": "string"
},
"type": {
"type": "integer"
},
"value": {},
"value_is_password_id": {
"type": "boolean"
},
"display": {
"type": "string"
},
"characterlimit": {
"type": "integer"
},
"characterlimittype": {
"type": "integer"
},
"inputtype": {
"type": "integer"
},
"copytochild": {
"type": "boolean"
},
"copytoparent": {
"type": "boolean"
},
"searchable": {
"type": "boolean"
},
"ordervalues": {
"type": "boolean"
},
"ordervaluesby": {
"type": "integer"
},
"database_lookup_id": {
"type": "integer"
},
"database_lookup_auto": {
"type": "boolean"
},
"database_lookup_triggers": {
"type": "array"
},
"third_party_name": {
"type": "string"
},
"extratype": {
"type": "integer"
},
"copytochildonupdate": {
"type": "boolean"
},
"copytograndchildonupdate": {
"type": "boolean"
},
"copytoparentonupdate": {
"type": "boolean"
},
"hyperlink": {
"type": "string"
},
"usage": {
"type": "integer"
},
"linked_table_id": {
"type": "integer"
},
"showondetailsscreen": {
"type": "boolean"
},
"third_party_value": {
"type": "string"
},
"custom_extra_table_id": {
"type": "integer"
},
"copytorelated": {
"type": "boolean"
},
"only_validate_on_creation": {
"type": "boolean"
},
"calculation": {
"type": "string"
},
"rounding": {
"type": "integer"
},
"validation_reasons": {
"type": "array"
},
"int_value_is_display": {
"type": "boolean"
},
"regex": {
"type": "string"
},
"onlyshowforagents": {
"type": "boolean"
},
"is_horizontal": {
"type": "boolean"
},
"copied": {
"type": "boolean"
},
"isencrypted": {
"type": "boolean"
},
"max_selection": {
"type": "integer"
},
"guid": {
"type": "string"
},
"selection_field_id": {
"type": "integer"
},
"variable_format_1": {
"type": "string"
},
"variable_format_2": {
"type": "string"
},
"validation_data": {
"type": "array"
},
"database_lookup_input": {
"type": "integer"
},
"table_data_entry_type": {
"type": "integer"
},
"showintable": {
"type": "boolean"
},
"table_height": {
"type": "integer"
},
"dont_delete_rows": {
"type": "boolean"
},
"table_matching_field": {
"type": "integer"
},
"new_storage_method": {
"type": "boolean"
},
"where_sql": {
"type": "string"
},
"load_type": {
"type": "integer"
},
"add_rows": {
"type": "boolean"
},
"delete_these_rows": {
"type": "array"
},
"showinpool": {
"type": "boolean"
},
"allow_pool_override": {
"type": "boolean"
},
"details_column_group": {
"type": "integer"
},
"add_row_per_value": {
"type": "boolean"
},
"store_in_fielddata": {
"type": "boolean"
},
"first_value_default": {
"type": "boolean"
},
"copytoparentnewticket": {
"type": "boolean"
}
}
},
"description": "The customfields value"
},
"limit_start_date": {
"type": "string",
"format": "date-time",
"description": "Limit Start Date"
},
"limit_end_date": {
"type": "string",
"format": "date-time",
"description": "Limit End Date"
},
"editor_type": {
"type": "integer",
"format": "int32",
"description": "Editor Type"
},
"kb_tags": {
"type": "string",
"description": "Kb Tags"
},
"agent_view_count": {
"type": "integer",
"format": "int32",
"description": "Agent View Count"
},
"confluence_url": {
"type": "string",
"description": "Confluence Url"
},
"search_score": {
"type": "number",
"format": "double",
"description": "Search Score"
},
"resolution_list": {
"type": "string",
"description": "Resolution List"
},
"link": {
"type": "string",
"description": "The link value"
},
"geo_restrictions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"table_id": {
"type": "integer"
},
"entity_id": {
"type": "integer"
},
"country_code": {
"type": "string"
},
"continent_code": {
"type": "string"
},
"exclude": {
"type": "boolean"
}
}
},
"description": "Geo Restrictions"
},
"resolution": {
"type": "string",
"description": "The resolution value"
},
"creator_id": {
"type": "integer",
"format": "int32",
"description": "Creator Id"
},
"creator_name": {
"type": "string",
"description": "Creator Name"
},
"editor_id": {
"type": "integer",
"format": "int32",
"description": "Editor Id"
},
"editor_name": {
"type": "string",
"description": "Editor Name"
},
"xrefkbentry": {
"type": "integer",
"format": "int32",
"description": "The xrefkbentry value"
},
"xreftype": {
"type": "integer",
"format": "int32",
"description": "The xreftype value"
},
"xrefdoc": {
"type": "integer",
"format": "int32",
"description": "The xrefdoc value"
},
"ticket_id": {
"type": "integer",
"format": "int32",
"description": "Ticket Id"
},
"description_html": {
"type": "string",
"description": "Description Html"
},
"description_markdown": {
"type": "string",
"description": "Description Markdown"
},
"resolution_html": {
"type": "string",
"description": "Resolution Html"
},
"resolution_markdown": {
"type": "string",
"description": "Resolution Markdown"
},
"internalmemoagent": {
"type": "string",
"description": "The internalmemoagent value"
},
"internalmemoagenthtml": {
"type": "string",
"description": "The internalmemoagenthtml value"
},
"internalmemomarkdown": {
"type": "string",
"description": "The internalmemomarkdown value"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"text": {
"type": "string"
},
"add_to_kbid": {
"type": "integer"
},
"add_to_ctid": {
"type": "integer"
},
"add_to_stid": {
"type": "integer"
},
"_warning": {
"type": "string"
},
"add_to_stdid": {
"type": "integer"
},
"type": {
"type": "integer"
}
}
},
"description": "The tags value"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"copytochildonupdate": {
"type": "boolean"
},
"id": {
"type": "integer"
},
"rtid": {
"type": "integer"
},
"usage": {
"type": "integer"
},
"fieldid": {
"type": "integer"
},
"fieldguid": {
"type": "string"
},
"seq": {
"type": "integer"
},
"tableid": {
"type": "integer"
},
"tableguid": {
"type": "string"
},
"groupid": {
"type": "integer"
},
"groupguid": {
"type": "string"
},
"endusernew": {
"type": "integer"
},
"enduserdetail": {
"type": "integer"
},
"enduserdetailrejected": {
"type": "integer"
},
"technew": {
"type": "integer"
},
"techdetail": {
"type": "integer"
},
"fieldname": {
"type": "string"
},
"fieldinfo": {
"type": "object"
},
"visibility_conditions": {
"type": "array"
},
"visibility_conditions_value": {
"type": "array"
},
"group_visibility_conditions": {
"type": "array"
},
"value_restrictions": {
"type": "array"
},
"group": {
"type": "object"
},
"technewlocation": {
"type": "integer"
},
"restrictupdate": {
"type": "integer"
},
"update_restrictions": {
"type": "array"
},
"techtab_id": {
"type": "integer"
},
"techtab_name": {
"type": "string"
},
"showdependency": {
"type": "boolean"
},
"canupdate": {
"type": "boolean"
},
"_warning": {
"type": "string"
},
"override_fieldname": {
"type": "string"
},
"override_action_fieldname": {
"type": "string"
},
"boldlabelandvalue": {
"type": "boolean"
},
"enduserdetailhideifempty": {
"type": "boolean"
},
"techdetailhideifempty": {
"type": "boolean"
},
"copytochild": {
"type": "boolean"
},
"copytorelated": {
"type": "boolean"
},
"restrictread": {
"type": "integer"
},
"read_restrictions": {
"type": "array"
},
"techtab_columns": {
"type": "integer"
},
"chat_message": {
"type": "string"
},
"techaction": {
"type": "integer"
},
"enduseraction": {
"type": "integer"
},
"endusercheckboxmandatory": {
"type": "boolean"
},
"translations": {
"type": "array"
},
"display_type": {
"type": "integer"
},
"copytoparent": {
"type": "boolean"
},
"copytoparentonupdate": {
"type": "boolean"
},
"agentcheckboxmandatory": {
"type": "boolean"
},
"agentbookingdetail": {
"type": "integer"
},
"copytoparentnewticket": {
"type": "boolean"
}
}
},
"description": "The fields value"
},
"teams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"guid": {
"type": "string"
},
"intent": {
"type": "string"
},
"name": {
"type": "string"
},
"sequence": {
"type": "integer"
},
"forrequests": {
"type": "boolean"
},
"foropps": {
"type": "boolean"
},
"forprojects": {
"type": "boolean"
},
"ticket_count": {
"type": "integer"
},
"department_id": {
"type": "integer"
},
"department_name": {
"type": "string"
},
"org_team_name": {
"type": "string"
},
"inactive": {
"type": "boolean"
},
"override_column_id": {
"type": "integer"
},
"managers": {
"type": "array"
},
"teamphotopath": {
"type": "string"
},
"last_modified": {
"type": "string"
},
"hide_agents_in_tree_if_no_tickets": {
"type": "boolean"
},
"timesheet_approver": {
"type": "integer"
},
"timesheet_approver_name": {
"type": "string"
},
"concurrent_lic_limit": {
"type": "integer"
},
"workinghoursbeforealert": {
"type": "number"
},
"emailaddress": {
"type": "string"
},
"addtoallagents": {
"type": "boolean"
},
"allowlivechat": {
"type": "boolean"
},
"rtid": {
"type": "integer"
},
"agents": {
"type": "array"
},
"organisation_id": {
"type": "integer"
},
"cannedtext": {
"type": "array"
},
"templates": {
"type": "array"
},
"allowall_category1": {
"type": "boolean"
},
"allowed_category1": {
"type": "array"
},
"allowall_category2": {
"type": "boolean"
},
"allowed_category2": {
"type": "array"
},
"allowall_category3": {
"type": "boolean"
},
"allowed_category3": {
"type": "array"
},
"allowall_category4": {
"type": "boolean"
},
"includeinloadbalance": {
"type": "boolean"
},
"allowed_category4": {
"type": "array"
},
"override_column_name": {
"type": "string"
},
"messagegroup_id": {
"type": "integer"
},
"_warning": {
"type": "string"
},
"_canupdate": {
"type": "boolean"
},
"_canupdate2": {
"type": "boolean"
},
"main_email_address": {
"type": "string"
},
"phone_number": {
"type": "string"
},
"timezone": {
"type": "string"
},
"alternative_name": {
"type": "string"
},
"logo": {
"type": "string"
},
"dontsendsurvey": {
"type": "boolean"
},
"team_note": {
"type": "string"
},
"booking_workday_id": {
"type": "integer"
},
"booking_workday_name": {
"type": "string"
},
"recurring_shifts": {
"type": "array"
},
"third_party_migration_id": {
"type": "string"
},
"enable_teams_shifts": {
"type": "boolean"
},
"load_balance_schedule": {
"type": "object"
},
"load_balance_interval": {
"type": "integer"
},
"load_balance_max_tickets": {
"type": "integer"
},
"load_balance_on_schedule": {
"type": "boolean"
},
"load_balance_schedule_frequency": {
"type": "integer"
},
"load_balance_max_tickets_this_team_only": {
"type": "boolean"
},
"load_balance_max_tickets_agent_specific": {
"type": "boolean"
},
"auto_load_balance_on_close": {
"type": "boolean"
},
"load_balance_agent_limits": {
"type": "array"
},
"new_cab_guid": {
"type": "string"
},
"new_external_link": {
"type": "object"
},
"_match_thirdparty_id": {
"type": "string"
},
"_match_additional_id": {
"type": "string"
},
"_match_integration_id": {
"type": "integer"
},
"_match_integration_name": {
"type": "string"
},
"_isimport": {
"type": "boolean"
},
"_importtype": {
"type": "string"
},
"import_details_id": {
"type": "integer"
},
"use": {
"type": "string"
},
"department_guid": {
"type": "string"
},
"homescreendashboardid": {
"type": "integer"
},
"homescreendashboardname": {
"type": "string"
},
"customfields": {
"type": "array"
},
"mailbox_override": {
"type": "integer"
}
}
},
"description": "The teams value"
},
"your_vote": {
"type": "integer",
"format": "int32",
"description": "Your Vote"
},
"showforall": {
"type": "boolean",
"description": "The showforall value"
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"filename": {
"type": "string"
},
"datecreated": {
"type": "string"
},
"note": {
"type": "string"
},
"filesize": {
"type": "integer"
},
"type": {
"type": "integer"
},
"unique_id": {
"type": "integer"
},
"desc": {
"type": "string"
},
"isimage": {
"type": "boolean"
},
"showforusers": {
"type": "boolean"
},
"showonchild": {
"type": "boolean"
},
"showonrelated": {
"type": "boolean"
},
"data_base64": {
"type": "string"
},
"download_url": {
"type": "string"
},
"third_party_token": {
"type": "string"
},
"third_party_id": {
"type": "string"
},
"already_posted": {
"type": "boolean"
},
"last_updated": {
"type": "string"
},
"faultid": {
"type": "integer"
},
"_isimport": {
"type": "boolean"
},
"_importtype": {
"type": "string"
},
"s3url": {
"type": "string"
},
"att_link": {
"type": "string"
},
"child_count": {
"type": "integer"
},
"parent_id": {
"type": "integer"
},
"linked_version_id": {
"type": "integer"
},
"allow_anon_upload": {
"type": "boolean"
},
"tickettype_id": {
"type": "integer"
},
"tickettype_guid": {
"type": "string"
},
"validate_guid": {
"type": "string"
},
"import_parentid": {
"type": "string"
},
"folder_hierarchy": {
"type": "string"
},
"access_control_level": {
"type": "integer"
},
"is_s3": {
"type": "boolean"
}
}
},
"description": "The attachments value"
},
"_isimport": {
"type": "boolean",
"description": "The isimport value"
},
"importfaqs": {
"type": "string",
"description": "The importfaqs value"
},
"last_review_date": {
"type": "string",
"format": "date-time",
"description": "Last Review Date"
},
"reviewed_by": {
"type": "integer",
"format": "int32",
"description": "Reviewed By"
},
"reviewer_name": {
"type": "string",
"description": "Reviewer Name"
},
"_reviewed": {
"type": "boolean",
"description": "The reviewed value"
},
"new_version_from_id": {
"type": "integer",
"format": "int32",
"description": "New Version From Id"
},
"other_versions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"view_count": {
"type": "integer"
},
"useful_count": {
"type": "integer"
},
"notuseful_count": {
"type": "integer"
},
"date_created": {
"type": "string"
},
"date_edited": {
"type": "string"
},
"tag_string": {
"type": "string"
},
"inactive": {
"type": "boolean"
},
"type": {
"type": "integer"
},
"next_review_date": {
"type": "string"
},
"customfields": {
"type": "array"
},
"limit_start_date": {
"type": "string"
},
"limit_end_date": {
"type": "string"
},
"editor_type": {
"type": "integer"
},
"kb_tags": {
"type": "string"
},
"agent_view_count": {
"type": "integer"
},
"confluence_url": {
"type": "string"
},
"search_score": {
"type": "number"
},
"resolution_list": {
"type": "string"
},
"link": {
"type": "string"
},
"geo_restrictions": {
"type": "array"
},
"use": {
"type": "string"
},
"key": {
"type": "integer"
},
"table": {
"type": "integer"
},
"ticket_template_id": {
"type": "integer"
},
"faqdseq": {
"type": "integer"
},
"faqliststr": {
"type": "string"
},
"faqlists": {
"type": "array"
},
"description_list": {
"type": "string"
},
"key_copy": {
"type": "string"
},
"all_version_view_count": {
"type": "integer"
},
"search_count": {
"type": "integer"
},
"_importtypeid": {
"type": "integer"
},
"_importthirdpartyid": {
"type": "string"
},
"_importtype": {
"type": "string"
},
"new_external_link": {
"type": "object"
},
"import_details_id": {
"type": "integer"
},
"_isupdateimport": {
"type": "boolean"
},
"_match_thirdparty_id": {
"type": "string"
},
"_match_integration_id": {
"type": "integer"
},
"_match_integration_name": {
"type": "string"
},
"_match_integration_button_caption": {
"type": "string"
},
"_match_integration_button_url": {
"type": "string"
},
"_match_integration_button_icon": {
"type": "string"
}
}
},
"description": "Other Versions"
},
"servicenow_id": {
"type": "string",
"description": "Servicenow Id"
},
"import_attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"third_party_id": {
"type": "string"
},
"link": {
"type": "string"
},
"content_type": {
"type": "string"
},
"last_updated": {
"type": "string"
},
"id": {
"type": "integer"
},
"filename": {
"type": "string"
},
"datecreated": {
"type": "string"
},
"note": {
"type": "string"
},
"filesize": {
"type": "integer"
},
"type": {
"type": "integer"
},
"unique_id": {
"type": "integer"
},
"desc": {
"type": "string"
},
"isimage": {
"type": "boolean"
},
"data": {
"type": "string"
},
"ticket_id": {
"type": "integer"
},
"action_id": {
"type": "integer"
},
"outcome_id": {
"type": "integer"
},
"user_id": {
"type": "integer"
},
"agent_id": {
"type": "integer"
},
"attachmentaction_id": {
"type": "integer"
},
"_canupdate": {
"type": "boolean"
},
"guid": {
"type": "string"
},
"image_upload_id": {
"type": "integer"
},
"image_upload_key": {
"type": "string"
},
"file": {
"type": "string"
},
"_enduserportalpdfprint": {
"type": "boolean"
},
"anon_outcomeid": {
"type": "integer"
},
"has_scanned": {
"type": "boolean"
},
"_warning": {
"type": "string"
},
"_is_new_version": {
"type": "boolean"
},
"parent_name": {
"type": "string"
},
"parent_desc": {
"type": "string"
},
"version_count": {
"type": "integer"
},
"_alreadyuploaded": {
"type": "boolean"
},
"copy_from_id": {
"type": "integer"
},
"new_external_link": {
"type": "object"
},
"_match_thirdparty_id": {
"type": "string"
},
"_match_additional_id": {
"type": "string"
},
"_match_integration_id": {
"type": "integer"
},
"_match_integration_name": {
"type": "string"
},
"import_details_id": {
"type": "integer"
},
"external_links": {
"type": "array"
},
"access_control": {
"type": "array"
},
"_start_transcription": {
"type": "boolean"
},
"_transcription_started": {
"type": "boolean"
},
"_transcription_is_new_action": {
"type": "boolean"
},
"showforusers": {
"type": "boolean"
},
"showonchild": {
"type": "boolean"
},
"showonrelated": {
"type": "boolean"
},
"data_base64": {
"type": "string"
},
"download_url": {
"type": "string"
},
"third_party_token": {
"type": "string"
},
"already_posted": {
"type": "boolean"
},
"faultid": {
"type": "integer"
},
"_isimport": {
"type": "boolean"
},
"_importtype": {
"type": "string"
},
"s3url": {
"type": "string"
},
"att_link": {
"type": "string"
},
"child_count": {
"type": "integer"
},
"parent_id": {
"type": "integer"
},
"linked_version_id": {
"type": "integer"
},
"allow_anon_upload": {
"type": "boolean"
},
"tickettype_id": {
"type": "integer"
},
"tickettype_guid": {
"type": "string"
},
"validate_guid": {
"type": "string"
},
"import_parentid": {
"type": "string"
},
"folder_hierarchy": {
"type": "string"
},
"access_control_level": {
"type": "integer"
},
"is_s3": {
"type": "boolean"
}
}
},
"description": "Import Attachments"
},
"related_articles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"view_count": {
"type": "integer"
},
"useful_count": {
"type": "integer"
},
"notuseful_count": {
"type": "integer"
},
"date_created": {
"type": "string"
},
"date_edited": {
"type": "string"
},
"tag_string": {
"type": "string"
},
"inactive": {
"type": "boolean"
},
"type": {
"type": "integer"
},
"next_review_date": {
"type": "string"
},
"customfields": {
"type": "array"
},
"limit_start_date": {
"type": "string"
},
"limit_end_date": {
"type": "string"
},
"editor_type": {
"type": "integer"
},
"kb_tags": {
"type": "string"
},
"agent_view_count": {
"type": "integer"
},
"confluence_url": {
"type": "string"
},
"search_score": {
"type": "number"
},
"resolution_list": {
"type": "string"
},
"link": {
"type": "string"
},
"geo_restrictions": {
"type": "array"
},
"use": {
"type": "string"
},
"key": {
"type": "integer"
},
"table": {
"type": "integer"
},
"ticket_template_id": {
"type": "integer"
},
"faqdseq": {
"type": "integer"
},
"faqliststr": {
"type": "string"
},
"faqlists": {
"type": "array"
},
"description_list": {
"type": "string"
},
"key_copy": {
"type": "string"
},
"all_version_view_count": {
"type": "integer"
},
"search_count": {
"type": "integer"
},
"_importtypeid": {
"type": "integer"
},
"_importthirdpartyid": {
"type": "string"
},
"_importtype": {
"type": "string"
},
"new_external_link": {
"type": "object"
},
"import_details_id": {
"type": "integer"
},
"_isupdateimport": {
"type": "boolean"
},
"_match_thirdparty_id": {
"type": "string"
},
"_match_integration_id": {
"type": "integer"
},
"_match_integration_name": {
"type": "string"
},
"_match_integration_button_caption": {
"type": "string"
},
"_match_integration_button_url": {
"type": "string"
},
"_match_integration_button_icon": {
"type": "string"
}
}
},
"description": "Related Articles"
},
"your_comment": {
"type": "string",
"description": "Your Comment"
},
"freshdesk_id": {
"type": "string",
"description": "Freshdesk Id"
},
"freshdesk_folder_name": {
"type": "string",
"description": "Freshdesk Folder Name"
},
"freshdesk_category_name": {
"type": "string",
"description": "Freshdesk Category Name"
},
"translations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"language_id": {
"type": "integer"
},
"entity": {
"type": "string"
},
"fieldname": {
"type": "string"
},
"entity_id": {
"type": "integer"
},
"entity_id2": {
"type": "integer"
},
"entity_id3": {
"type": "integer"
},
"entity_textid": {
"type": "string"
},
"translation": {
"type": "string"
},
"_dotranslate": {
"type": "boolean"
},
"_translateonly": {
"type": "boolean"
},
"_isimport": {
"type": "boolean"
},
"default_translation": {
"type": "string"
},
"_warning": {
"type": "string"
}
}
},
"description": "The translations value"
},
"_print_generate": {
"type": "boolean",
"description": "Print Generate"
},
"printhtml": {
"type": "string",
"description": "The printhtml value"
},
"pdf_attachment_id": {
"type": "integer",
"format": "int32",
"description": "Pdf Attachment Id"
},
"pdftemplate_id": {
"type": "integer",
"format": "int32",
"description": "Pdftemplate Id"
},
"pdftemplate_name": {
"type": "string",
"description": "Pdftemplate Name"
},
"kbentryclientaccess": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"client_id": {
"type": "integer"
},
"client_name": {
"type": "string"
},
"kb_id": {
"type": "integer"
},
"_warning": {
"type": "string"
}
}
},
"description": "The kbentryclientaccess value"
},
"kbentrytoplevelaccess": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"toplevel_id": {
"type": "integer"
},
"toplevel_name": {
"type": "string"
},
"kb_id": {
"type": "integer"
},
"_warning": {
"type": "string"
}
}
},
"description": "The kbentrytoplevelaccess value"
},
"_warning": {
"type": "string",
"description": "The warning value"
},
"devices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"changeguid": {
"type": "string"
},
"intent": {
"type": "string"
},
"inventory_number": {
"type": "string"
},
"key_field": {
"type": "string"
},
"key_field2": {
"type": "string"
},
"key_field3": {
"type": "string"
},
"client_id": {
"type": "integer"
},
"client_name": {
"type": "string"
},
"site_id": {
"type": "integer"
},
"site_name": {
"type": "string"
},
"business_owner_id": {
"type": "integer"
},
"business_owner_name": {
"type": "string"
},
"business_owner_site": {
"type": "string"
},
"business_owner_client": {
"type": "string"
},
"business_owner_cab_id": {
"type": "integer"
},
"business_owner_cab_name": {
"type": "string"
},
"username": {
"type": "string"
},
"technical_owner_id": {
"type": "integer"
},
"technical_owner_name": {
"type": "string"
},
"technical_owner_cab_id": {
"type": "integer"
},
"technical_owner_cab_name": {
"type": "string"
},
"intune_default_site": {
"type": "integer"
},
"assettype_id": {
"type": "integer"
},
"assettype_name": {
"type": "string"
},
"colour": {
"type": "string"
},
"icon": {
"type": "string"
},
"warranty_end": {
"type": "string"
},
"inactive": {
"type": "boolean"
},
"is_primary_asset": {
"type": "boolean"
},
"parent_id": {
"type": "integer"
},
"lansweeper_parent_id": {
"type": "string"
},
"child_id": {
"type": "integer"
},
"sibling_id": {
"type": "boolean"
},
"contract_value": {
"type": "number"
},
"contract_ref": {
"type": "string"
},
"contract_id": {
"type": "integer"
},
"supplier_id": {
"type": "integer"
},
"supplier_name": {
"type": "string"
},
"manufacturer_id": {
"type": "integer"
},
"manufacturer_name": {
"type": "string"
},
"supplier_contract_id": {
"type": "integer"
},
"supplier_contract_ref": {
"type": "string"
},
"supplier_sla_id": {
"type": "integer"
},
"supplier_priority_id": {
"type": "integer"
},
"fields": {
"type": "array"
},
"customfields": {
"type": "array"
},
"relationship_id": {
"type": "integer"
},
"default_contract_value": {
"type": "number"
},
"itemstock_id": {
"type": "integer"
},
"item_id": {
"type": "integer"
},
"stock_date": {
"type": "string"
},
"non_consignable": {
"type": "boolean"
},
"reserved_salesorder_id": {
"type": "integer"
},
"reserved_salesorder_line_id": {
"type": "integer"
},
"matching_field": {
"type": "string"
},
"is_auto_picking_asset_tag": {
"type": "boolean"
},
"device42_id": {
"type": "integer"
},
"device42_url": {
"type": "string"
},
"related_services": {
"type": "string"
},
"technical_owner": {
"type": "string"
},
"business_owner": {
"type": "string"
},
"primary_asset_chart_json": {
"type": "string"
},
"criticality": {
"type": "integer"
},
"service_id": {
"type": "integer"
},
"key": {
"type": "integer"
},
"table": {
"type": "integer"
},
"use": {
"type": "string"
},
"device_number": {
"type": "integer"
},
"assettype_guid": {
"type": "string"
},
"owning_portfolio_name": {
"type": "string"
},
"owning_service_name": {
"type": "string"
},
"owning_businessapp_name": {
"type": "string"
},
"owning_ci_name": {
"type": "string"
},
"warranty_start": {
"type": "string"
},
"labour_warranty_start": {
"type": "string"
},
"labour_warranty_end": {
"type": "string"
},
"parent_guid": {
"type": "string"
},
"child_guid": {
"type": "string"
},
"status_id": {
"type": "integer"
},
"status_name": {
"type": "string"
},
"third_party_id": {
"type": "integer"
},
"sla_name": {
"type": "string"
},
"priority_name": {
"type": "string"
},
"latest_contract_ref": {
"type": "string"
},
"sequence": {
"type": "integer"
},
"ncentral_url": {
"type": "string"
},
"ncentral_remote_url": {
"type": "string"
},
"contract_end_date": {
"type": "string"
},
"atera_id": {
"type": "string"
},
"automate_id": {
"type": "integer"
},
"automate_url": {
"type": "string"
},
"connectwise_control_url": {
"type": "string"
},
"ninjarmm_id": {
"type": "integer"
},
"ninja_url": {
"type": "string"
},
"ninja_remote_url": {
"type": "string"
},
"syncro_url": {
"type": "string"
},
"syncroid": {
"type": "integer"
},
"itglue_url": {
"type": "string"
},
"defaultsequence": {
"type": "integer"
},
"service_ids": {
"type": "string"
},
"bulkcreated": {
"type": "boolean"
},
"bulkbillingperiod": {
"type": "integer"
},
"asset_field": {
"type": "string"
},
"datto_alternate_id": {
"type": "integer"
},
"syncro_id": {
"type": "string"
},
"domotz_id": {
"type": "string"
},
"snow_id": {
"type": "integer"
},
"passportal_id": {
"type": "integer"
},
"auvik_device_id": {
"type": "string"
},
"auvik_url": {
"type": "string"
},
"allowallstatus": {
"type": "boolean"
},
"allowed_status": {
"type": "array"
},
"allowallcustombuttons": {
"type": "boolean"
},
"allowed_custombuttons": {
"type": "array"
},
"datto_id": {
"type": "string"
},
"addigy_id": {
"type": "string"
},
"liongard_url": {
"type": "string"
},
"liongard_environmnet_id": {
"type": "integer"
},
"liongard_id": {
"type": "string"
},
"kaseya_id": {
"type": "string"
},
"iskaseyaagent": {
"type": "boolean"
},
"kaseyavsa_url": {
"type": "string"
},
"addigy_url": {
"type": "string"
},
"teamviewerid": {
"type": "string"
},
"serialization_user": {
"type": "integer"
},
"zabbix_id": {
"type": "string"
},
"zabbix_url": {
"type": "string"
},
"stockbin_name": {
"type": "string"
},
"issue_consignment_line_id": {
"type": "integer"
},
"item_name": {
"type": "string"
},
"datto_url": {
"type": "string"
},
"ncentral_details_id": {
"type": "integer"
},
"nable_id": {
"type": "string"
},
"connectwisecontrolid": {
"type": "string"
},
"_isimport": {
"type": "boolean"
},
"_importtype": {
"type": "string"
},
"workspace_id": {
"type": "string"
},
"workspace_url": {
"type": "string"
},
"intune_id": {
"type": "string"
},
"supplier_purchasedate": {
"type": "string"
},
"logicmonitor_id": {
"type": "string"
},
"barracudarmm_id": {
"type": "string"
},
"sla_id": {
"type": "integer"
},
"priority_id": {
"type": "integer"
},
"icinga_id": {
"type": "string"
},
"related_service_name": {
"type": "string"
},
"related_service_count": {
"type": "integer"
},
"connectwisermm_id": {
"type": "string"
},
"xensam_id": {
"type": "string"
},
"asset_type_priority": {
"type": "integer"
},
"snipeit_id": {
"type": "string"
},
"prometheus_id": {
"type": "string"
},
"dynatrace_id": {
"type": "string"
},
"vmworkspace_id": {
"type": "string"
},
"tanium_id": {
"type": "string"
},
"tenable_id": {
"type": "string"
},
"kandji_id": {
"type": "string"
},
"criticality_description": {
"type": "string"
},
"auvik_id": {
"type": "string"
},
"is_template": {
"type": "boolean"
},
"aws_id": {
"type": "string"
},
"manageengine_id": {
"type": "string"
},
"manageengine_customer_id": {
"type": "string"
},
"lastchangeofvaluedate": {
"type": "string"
},
"commissiondate": {
"type": "string"
},
"first_user_id": {
"type": "integer"
},
"changebackupexists": {
"type": "boolean"
},
"_isbatch": {
"type": "boolean"
},
"virima_id": {
"type": "string"
},
"service_guid": {
"type": "string"
},
"service_name": {
"type": "string"
},
"lansweeperid": {
"type": "string"
},
"eracent_id": {
"type": "string"
},
"changehistory_last_updated": {
"type": "string"
},
"changehistory_updated_by": {
"type": "string"
},
"changehistory_created_by": {
"type": "string"
},
"changehistory_created_date": {
"type": "string"
},
"auto_link": {
"type": "boolean"
},
"impact_statement": {
"type": "string"
},
"activity_statement": {
"type": "string"
},
"raynet_id": {
"type": "string"
},
"armis_id": {
"type": "string"
},
"kaseyavsax_id": {
"type": "string"
},
"diagram_field1": {
"type": "string"
},
"diagram_field2": {
"type": "string"
},
"diagram_field3": {
"type": "string"
},
"ci_type": {
"type": "integer"
},
"manually_linked_ticket": {
"type": "boolean"
},
"_importtypeid": {
"type": "integer"
},
"_importthirdpartyid": {
"type": "string"
},
"new_external_link": {
"type": "object"
},
"import_details_id": {
"type": "integer"
},
"_isupdateimport": {
"type": "boolean"
},
"_match_thirdparty_id": {
"type": "string"
},
"_match_integration_id": {
"type": "integer"
},
"_match_integration_name": {
"type": "string"
},
"_match_integration_button_caption": {
"type": "string"
},
"_match_integration_button_url": {
"type": "string"
},
"_match_integration_button_icon": {
"type": "string"
}
}
},
"description": "The devices value"
},
"faq_write": {
"type": "boolean",
"description": "Faq Write"
},
"new_external_link": {
"type": "object",
"description": "New External Link"
},
"_match_thirdparty_id": {
"type": "string",
"description": "Match Thirdparty Id"
},
"_match_additional_id": {
"type": "string",
"description": "Match Additional Id"
},
"_match_integration_id": {
"type": "integer",
"format": "int32",
"description": "Match Integration Id"
},
"_match_integration_name": {
"type": "string",
"description": "Match Integration Name"
},
"external_links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"table_id": {
"type": "integer"
},
"module_id": {
"type": "integer"
},
"integration_name": {
"type": "string"
},
"halo_id": {
"type": "integer"
},
"third_party_id": {
"type": "string"
},
"third_party_desc": {
"type": "string"
},
"third_party_type": {
"type": "string"
},
"third_party_url": {
"type": "string"
},
"third_party_assigned_to": {
"type": "string"
},
"third_party_count": {
"type": "integer"
},
"primary": {
"type": "boolean"
},
"halo_desc": {
"type": "string"
},
"halo_second_id": {
"type": "integer"
},
"halo_second_desc": {
"type": "string"
},
"extra_match_field": {
"type": "string"
},
"details_id": {
"type": "integer"
},
"third_party_secondary_id": {
"type": "string"
},
"_warning": {
"type": "string"
},
"third_party_status": {
"type": "string"
},
"third_party_priority": {
"type": "string"
},
"_match": {
"type": "boolean"
},
"populate_url": {
"type": "boolean"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"subscription_id": {
"type": "string"
},
"new_subscription_key": {
"type": "string"
},
"subscription_expiry": {
"type": "string"
},
"_webhookaction": {
"type": "integer"
},
"revisions": {
"type": "integer"
},
"dont_move_existing_assets": {
"type": "boolean"
},
"chat_message_count": {
"type": "integer"
},
"third_party_additional_id": {
"type": "string"
},
"description": {
"type": "string"
},
"update_existing_link": {
"type": "boolean"
},
"filters": {
"type": "array"
},
"parent_id": {
"type": "integer"
},
"child_links": {
"type": "array"
},
"url_for_linked_entity": {
"type": "string"
},
"url_for_linked_entity_caption": {
"type": "string"
},
"icon_for_linked_entity_caption": {
"type": "string"
}
}
},
"description": "External Links"
},
"wordpress_tags": {
"type": "object",
"description": "Wordpress Tags"
},
"wordpress_categories": {
"type": "object",
"description": "Wordpress Categories"
},
"importtags": {
"type": "string",
"description": "The importtags value"
},
"owners": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"article_id": {
"type": "integer"
},
"agent_id": {
"type": "integer"
},
"team_id": {
"type": "integer"
},
"name": {
"type": "string"
},
"owner_type": {
"type": "integer"
}
}
},
"description": "The owners value"
},
"search_index_sync_timestamp": {
"type": "string",
"format": "date-time",
"description": "Search Index Sync Timestamp"
},
"search_index_sync_batches": {
"type": "integer",
"format": "int32",
"description": "Search Index Sync Batches"
},
"kbpermalinks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"entity_name": {
"type": "string"
},
"entity_id": {
"type": "integer"
},
"published_guid": {
"type": "string"
},
"access_token": {
"type": "string"
},
"custom_path": {
"type": "string"
},
"publishedlink": {
"type": "string"
},
"_warning": {
"type": "string"
}
}
},
"description": "The kbpermalinks value"
},
"negativeFeedbackTicket": {
"type": "object",
"description": "Negative Feedback Ticket"
},
"generatetoken": {
"type": "boolean",
"description": "The generatetoken value"
},
"latestversion": {
"type": "integer",
"format": "int32",
"description": "The latestversion value"
},
"creator_userid": {
"type": "integer",
"format": "int32",
"description": "Creator Userid"
},
"permalink_type": {
"type": "integer",
"format": "int32",
"description": "Permalink Type"
},
"custom_permalink": {
"type": "string",
"description": "Custom Permalink"
},
"add_tags": {
"type": "boolean",
"description": "Add Tags"
},
"add_faq_lists": {
"type": "boolean",
"description": "Add Faq Lists"
},
"style_profile_links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"styleprofile_id": {
"type": "integer"
},
"entityid": {
"type": "integer"
},
"entityguid": {
"type": "string"
},
"entity_name": {
"type": "string"
},
"profile_name": {
"type": "string"
},
"precedence": {
"type": "integer"
},
"type": {
"type": "integer"
},
"_warning": {
"type": "string"
}
}
},
"description": "Style Profile Links"
},
"style_profile_rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"styleprofile_id": {
"type": "integer"
},
"selector": {
"type": "string"
},
"style": {
"type": "string"
},
"_warning": {
"type": "string"
},
"precedence": {
"type": "integer"
}
}
},
"description": "Style Profile Rules"
},
"active_draft_id": {
"type": "integer",
"format": "int32",
"description": "Active Draft Id"
},
"_kbduplicate01_ok": {
"type": "boolean",
"description": "Kbduplicate01 Ok"
},
"ai_generated_summary": {
"type": "string",
"description": "Ai Generated Summary"
},
"ai_summary": {
"type": "string",
"description": "Ai Summary"
},
"_isclone": {
"type": "boolean",
"description": "The isclone value"
},
"is_an_owner": {
"type": "boolean",
"description": "Is An Owner"
},
"doc_needs_processing": {
"type": "boolean",
"description": "Doc Needs Processing"
},
"doc_processed": {
"type": "boolean",
"description": "Doc Processed"
},
"feedback_tickettype_anon": {
"type": "boolean",
"description": "Feedback Tickettype Anon"
},
"access_control_level": {
"type": "integer",
"format": "int32",
"description": "Access Control Level"
},
"use": {
"type": "string",
"description": "The use value"
},
"key": {
"type": "integer",
"format": "int32",
"description": "The key value"
},
"table": {
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
980,
986,
987,
988,
989,
990,
991,
992,
993,
995,
996,
997,
998,
999,
1001,
1002,
1003,
1005,
1006,
1007,
1008,
1009,
1010,
1011,
1012,
1013,
1014,
1015,
1016,
1017,
1018,
1019,
1020,
1021,
1022,
1023,
1024,
1025,
1026,
1027,
1029,
1030,
1031,
1035,
-1
],
"description": "The table value"
},
"ticket_template_id": {
"type": "integer",
"format": "int32",
"description": "Ticket Template Id"
},
"faqdseq": {
"type": "integer",
"format": "int32",
"description": "The faqdseq value"
},
"faqliststr": {
"type": "string",
"description": "The faqliststr value"
},
"faqlists": {
"type": "array",
"items": {
"type": "object",
"properties": {
"guid": {
"type": "string"
},
"intent": {
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"showforall": {
"type": "boolean"
},
"showforallagents": {
"type": "boolean"
},
"level": {
"type": "integer"
},
"description": {
"type": "string"
},
"is_group": {
"type": "boolean"
},
"group_id": {
"type": "integer"
},
"group_name": {
"type": "string"
},
"full_name": {
"type": "string"
},
"sequence": {
"type": "integer"
},
"article_count": {
"type": "integer"
},
"type": {
"type": "integer"
},
"grandparent_name": {
"type": "string"
},
"greatgrandparent_name": {
"type": "string"
},
"greatgreatgrandparent_name": {
"type": "string"
},
"greatgreatgreatgrandparent_name": {
"type": "string"
},
"fullgroup_name": {
"type": "string"
},
"new_external_link": {
"type": "object"
},
"_match_thirdparty_id": {
"type": "string"
},
"_match_additional_id": {
"type": "string"
},
"_match_integration_id": {
"type": "integer"
},
"_match_integration_name": {
"type": "string"
},
"_isimport": {
"type": "boolean"
},
"_importtype": {
"type": "string"
},
"import_details_id": {
"type": "integer"
},
"third_party_id": {
"type": "string"
},
"translations": {
"type": "array"
},
"access_control": {
"type": "array"
},
"access_control_level": {
"type": "integer"
},
"dontshowonportal": {
"type": "boolean"
},
"allow_indexing": {
"type": "boolean"
},
"geo_restrictions": {
"type": "array"
},
"linked_articles": {
"type": "array"
},
"style_profile_links": {
"type": "array"
},
"showtoallwithperms": {
"type": "boolean"
},
"show_to_all_suppliers": {
"type": "boolean"
}
}
},
"description": "The faqlists value"
},
"description_list": {
"type": "string",
"description": "Description List"
},
"key_copy": {
"type": "string",
"format": "uuid",
"description": "Key Copy"
},
"all_version_view_count": {
"type": "integer",
"format": "int32",
"description": "All Version View Count"
},
"search_count": {
"type": "integer",
"format": "int32",
"description": "Search Count"
},
"_importtypeid": {
"type": "integer",
"format": "int32",
"description": "The importtypeid value"
},
"_importthirdpartyid": {
"type": "string",
"description": "The importthirdpartyid value"
},
"_importtype": {
"type": "string",
"description": "The importtype value"
},
"import_details_id": {
"type": "integer",
"format": "int32",
"description": "Import Details Id"
},
"_isupdateimport": {
"type": "boolean",
"description": "The isupdateimport value"
},
"_match_integration_button_caption": {
"type": "string",
"description": "Match Integration Button Caption"
},
"_match_integration_button_url": {
"type": "string",
"description": "Match Integration Button Url"
},
"_match_integration_button_icon": {
"type": "string",
"description": "Match Integration Button Icon"
}
}
},
"description": "Request body"
}
},
"required": [
"PCID"
]
}
```
***
## haloitsm\_knowledge\_create\_report
POST /Report
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | ------------ |
| `body` | object\[] | No | — | Request body |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"body": {
"type": "array",
"items": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"format": "uuid",
"description": "The guid value"
},
"id": {
"type": "integer",
"format": "int32",
"description": "The id value"
},
"intent": {
"type": "string",
"description": "The intent value"
},
"name": {
"type": "string",
"description": "The name value"
},
"sql": {
"type": "string",
"description": "The sql value"
},
"reportingperiod": {
"type": "integer",
"format": "int32",
"description": "The reportingperiod value"
},
"availablefields": {
"type": "string",
"description": "The availablefields value"
},
"selectedfields": {
"type": "string",
"description": "The selectedfields value"
},
"reportingperiodstartdate": {
"type": "string",
"format": "date-time",
"description": "The reportingperiodstartdate value"
},
"reportingperiodenddate": {
"type": "string",
"format": "date-time",
"description": "The reportingperiodenddate value"
},
"reportingperioddatefield": {
"type": "string",
"description": "The reportingperioddatefield value"
},
"reporting_period_date_only": {
"type": "boolean",
"description": "Reporting Period Date Only"
},
"sqlid": {
"type": "integer",
"format": "int32",
"description": "The sqlid value"
},
"charttitle": {
"type": "string",
"description": "The charttitle value"
},
"xaxis": {
"type": "string",
"description": "The xaxis value"
},
"yaxis": {
"type": "string",
"description": "The yaxis value"
},
"xaxiscaption": {
"type": "string",
"description": "The xaxiscaption value"
},
"yaxiscaption": {
"type": "string",
"description": "The yaxiscaption value"
},
"graphorderby": {
"type": "string",
"description": "The graphorderby value"
},
"charttype": {
"type": "integer",
"format": "int32",
"description": "The charttype value"
},
"graphorder": {
"type": "integer",
"format": "int32",
"description": "The graphorder value"
},
"count": {
"type": "boolean",
"description": "The count value"
},
"sum": {
"type": "boolean",
"description": "The sum value"
},
"average": {
"type": "boolean",
"description": "The average value"
},
"averageaspercentage": {
"type": "boolean",
"description": "The averageaspercentage value"
},
"filterbarsbyfield": {
"type": "string",
"description": "The filterbarsbyfield value"
},
"filterbarsbyfield_allowchange": {
"type": "boolean",
"description": "Filterbarsbyfield Allowchange"
},
"chart_carry_forward": {
"type": "boolean",
"description": "Chart Carry Forward"
},
"showgraphvalues": {
"type": "boolean",
"description": "The showgraphvalues value"
},
"client": {
"type": "string",
"description": "The client value"
},
"builtinid": {
"type": "boolean",
"description": "The builtinid value"
},
"seriestype1": {
"type": "integer",
"format": "int32",
"description": "The seriestype1 value"
},
"seriestype2": {
"type": "integer",
"format": "int32",
"description": "The seriestype2 value"
},
"seriestype3": {
"type": "integer",
"format": "int32",
"description": "The seriestype3 value"
},
"seriestype4": {
"type": "integer",
"format": "int32",
"description": "The seriestype4 value"
},
"seriestype5": {
"type": "integer",
"format": "int32",
"description": "The seriestype5 value"
},
"yaxis1": {
"type": "string",
"description": "The yaxis1 value"
},
"yaxis2": {
"type": "string",
"description": "The yaxis2 value"
},
"yaxis3": {
"type": "string",
"description": "The yaxis3 value"
},
"yaxis4": {
"type": "string",
"description": "The yaxis4 value"
},
"yaxis5": {
"type": "string",
"description": "The yaxis5 value"
},
"stackbars": {
"type": "boolean",
"description": "The stackbars value"
},
"includesummary": {
"type": "boolean",
"description": "The includesummary value"
},
"timezonename": {
"type": "string",
"description": "The timezonename value"
},
"onlyshowsummaries": {
"type": "boolean",
"description": "The onlyshowsummaries value"
},
"usetechlink": {
"type": "boolean",
"description": "The usetechlink value"
},
"is_published": {
"type": "boolean",
"description": "Is Published"
},
"published_id": {
"type": "string",
"description": "Published Id"
},
"sqlhasdatefilter": {
"type": "boolean",
"description": "The sqlhasdatefilter value"
},
"usesdynamicsql": {
"type": "boolean",
"description": "The usesdynamicsql value"
},
"available_columns": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"report_id": {
"type": "integer"
},
"name": {
"type": "string"
},
"sys_name": {
"type": "string"
},
"query": {
"type": "string"
},
"data_type": {
"type": "string"
},
"data_type_group": {
"type": "string"
},
"select_format": {
"type": "string"
},
"table_name": {
"type": "string"
},
"customextratableid": {
"type": "integer"
},
"sequence": {
"type": "integer"
},
"filter": {
"type": "string"
},
"operation": {
"type": "integer"
},
"groupbystatus": {
"type": "integer"
},
"groupbycalc": {
"type": "integer"
},
"hidden": {
"type": "boolean"
},
"labellong": {
"type": "string"
},
"orderby": {
"type": "integer"
},
"orderby_desc": {
"type": "boolean"
},
"allowlookup": {
"type": "boolean"
},
"is_identifier": {
"type": "boolean"
},
"is_money_field": {
"type": "boolean"
},
"translatedname": {
"type": "string"
},
"translations": {
"type": "array"
},
"table_alias": {
"type": "string"
},
"table_joins": {
"type": "array"
},
"_warning": {
"type": "string"
}
}
},
"description": "Available Columns"
},
"columns": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"report_id": {
"type": "integer"
},
"name": {
"type": "string"
},
"sys_name": {
"type": "string"
},
"query": {
"type": "string"
},
"data_type": {
"type": "string"
},
"data_type_group": {
"type": "string"
},
"select_format": {
"type": "string"
},
"table_name": {
"type": "string"
},
"customextratableid": {
"type": "integer"
},
"sequence": {
"type": "integer"
},
"filter": {
"type": "string"
},
"operation": {
"type": "integer"
},
"groupbystatus": {
"type": "integer"
},
"groupbycalc": {
"type": "integer"
},
"hidden": {
"type": "boolean"
},
"labellong": {
"type": "string"
},
"orderby": {
"type": "integer"
},
"orderby_desc": {
"type": "boolean"
},
"allowlookup": {
"type": "boolean"
},
"is_identifier": {
"type": "boolean"
},
"is_money_field": {
"type": "boolean"
},
"translatedname": {
"type": "string"
},
"translations": {
"type": "array"
},
"table_alias": {
"type": "string"
},
"table_joins": {
"type": "array"
},
"_warning": {
"type": "string"
}
}
},
"description": "The columns value"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"report_id": {
"type": "integer"
},
"fieldname": {
"type": "string"
},
"data_type": {
"type": "string"
},
"data_type_group": {
"type": "string"
},
"query": {
"type": "string"
},
"numericruletype": {
"type": "integer"
},
"numericvalue": {
"type": "number"
},
"stringrulevalues": {
"type": "array"
},
"numericrulevalues": {
"type": "array"
},
"stringruletext": {
"type": "string"
},
"stringruletype": {
"type": "integer"
},
"_warning": {
"type": "string"
}
}
},
"description": "The filters value"
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"report_id": {
"type": "integer"
},
"fieldname": {
"type": "string"
},
"data_type": {
"type": "string"
},
"data_type_group": {
"type": "string"
},
"query": {
"type": "string"
},
"numericruletype": {
"type": "integer"
},
"numericvalue": {
"type": "number"
},
"stringrulevalues": {
"type": "array"
},
"numericrulevalues": {
"type": "array"
},
"stringruletext": {
"type": "string"
},
"stringruletype": {
"type": "integer"
},
"_warning": {
"type": "string"
}
}
},
"description": "The conditions value"
},
"filterable_columns": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"report_id": {
"type": "integer"
},
"name": {
"type": "string"
},
"sys_name": {
"type": "string"
},
"query": {
"type": "string"
},
"data_type": {
"type": "string"
},
"data_type_group": {
"type": "string"
},
"select_format": {
"type": "string"
},
"table_name": {
"type": "string"
},
"customextratableid": {
"type": "integer"
},
"sequence": {
"type": "integer"
},
"filter": {
"type": "string"
},
"operation": {
"type": "integer"
},
"groupbystatus": {
"type": "integer"
},
"groupbycalc": {
"type": "integer"
},
"hidden": {
"type": "boolean"
},
"labellong": {
"type": "string"
},
"orderby": {
"type": "integer"
},
"orderby_desc": {
"type": "boolean"
},
"allowlookup": {
"type": "boolean"
},
"is_identifier": {
"type": "boolean"
},
"is_money_field": {
"type": "boolean"
},
"translatedname": {
"type": "string"
},
"translations": {
"type": "array"
},
"table_alias": {
"type": "string"
},
"table_joins": {
"type": "array"
},
"_warning": {
"type": "string"
}
}
},
"description": "Filterable Columns"
},
"filterable_columns_conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"report_id": {
"type": "integer"
},
"name": {
"type": "string"
},
"sys_name": {
"type": "string"
},
"query": {
"type": "string"
},
"data_type": {
"type": "string"
},
"data_type_group": {
"type": "string"
},
"select_format": {
"type": "string"
},
"table_name": {
"type": "string"
},
"customextratableid": {
"type": "integer"
},
"sequence": {
"type": "integer"
},
"filter": {
"type": "string"
},
"operation": {
"type": "integer"
},
"groupbystatus": {
"type": "integer"
},
"groupbycalc": {
"type": "integer"
},
"hidden": {
"type": "boolean"
},
"labellong": {
"type": "string"
},
"orderby": {
"type": "integer"
},
"orderby_desc": {
"type": "boolean"
},
"allowlookup": {
"type": "boolean"
},
"is_identifier": {
"type": "boolean"
},
"is_money_field": {
"type": "boolean"
},
"translatedname": {
"type": "string"
},
"translations": {
"type": "array"
},
"table_alias": {
"type": "string"
},
"table_joins": {
"type": "array"
},
"_warning": {
"type": "string"
}
}
},
"description": "Filterable Columns Conditions"
},
"permissions_agent": {
"type": "array",
"items": {
"type": "object",
"properties": {
"agent_id": {
"type": "integer"
},
"agent_name": {
"type": "string"
},
"report_id": {
"type": "integer"
},
"readonly": {
"type": "boolean"
}
}
},
"description": "Permissions Agent"
},
"permissions_user": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"user_id": {
"type": "integer"
},
"user_name": {
"type": "string"
},
"report_id": {
"type": "integer"
},
"client_id": {
"type": "integer"
},
"client_name": {
"type": "string"
},
"site_id": {
"type": "integer"
},
"site_name": {
"type": "string"
},
"role_id": {
"type": "integer"
},
"role_name": {
"type": "string"
},
"type": {
"type": "string"
},
"allow_everyone": {
"type": "boolean"
},
"department_id": {
"type": "integer"
},
"department_name": {
"type": "string"
},
"organisation_id": {
"type": "integer"
},
"organisation_name": {
"type": "string"
}
}
},
"description": "Permissions User"
},
"schedule": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"guid": {
"type": "string"
},
"intent": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "integer"
},
"domain": {
"type": "string"
},
"group_id": {
"type": "integer"
},
"restriction_type": {
"type": "string"
},
"restrictto_department_id": {
"type": "integer"
},
"restrictto_department_name": {
"type": "string"
},
"restrictto_team_id": {
"type": "integer"
},
"restrictto_team_name": {
"type": "string"
},
"restrictto_agent_id": {
"type": "integer"
},
"restrictto_agent_name": {
"type": "string"
},
"summary": {
"type": "string"
},
"tickettype_id": {
"type": "integer"
},
"rule_count": {
"type": "integer"
},
"creation_rules": {
"type": "array"
},
"todo_list": {
"type": "array"
},
"emailto": {
"type": "string"
},
"emailcc": {
"type": "string"
},
"emailbcc": {
"type": "string"
},
"emailsubject": {
"type": "string"
},
"time": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"lastcreated": {
"type": "string"
},
"nextcreationdate": {
"type": "string"
},
"nextcreationdate_after_end": {
"type": "string"
},
"execution_type": {
"type": "integer"
},
"startdate": {
"type": "string"
},
"end_date": {
"type": "string"
},
"period": {
"type": "integer"
},
"create_locked": {
"type": "boolean"
},
"one_ticket_id": {
"type": "integer"
},
"created_ticket_id": {
"type": "integer"
},
"approval_id": {
"type": "integer"
},
"reportarea": {
"type": "integer"
},
"reportarea_name": {
"type": "string"
},
"restrictto_department_guid": {
"type": "string"
},
"restrictto_team_guid": {
"type": "string"
},
"clients": {
"type": "string"
},
"tickettype_guid": {
"type": "string"
},
"automationtype": {
"type": "integer"
},
"optionalservice": {
"type": "integer"
},
"optional_agent_id": {
"type": "integer"
},
"optional_team": {
"type": "string"
},
"optional_status_id": {
"type": "integer"
},
"optional_tickettype_id": {
"type": "integer"
},
"optional_create_locked": {
"type": "boolean"
},
"optional_defaultresourcetype": {
"type": "integer"
},
"optional_excludefromsla": {
"type": "integer"
},
"optional_customfields": {
"type": "array"
},
"optional_assets": {
"type": "array"
},
"optional_forwardinboundupdates": {
"type": "integer"
},
"optional_showforusers": {
"type": "integer"
},
"optional_urgency": {
"type": "integer"
},
"optional_impact": {
"type": "integer"
},
"optional_workflow_id": {
"type": "integer"
},
"optional_estimate": {
"type": "number"
},
"optional_category_1": {
"type": "string"
},
"optional_category_2": {
"type": "string"
},
"optional_category_3": {
"type": "string"
},
"optional_category_4": {
"type": "string"
},
"optional_priority_id": {
"type": "integer"
},
"optional_budgettype_id": {
"type": "integer"
},
"optional_kb_id": {
"type": "integer"
},
"optional_service": {
"type": "integer"
},
"optional_service_details_id": {
"type": "integer"
},
"service": {
"type": "integer"
},
"optional_sla_id": {
"type": "integer"
},
"parent_customfields": {
"type": "array"
}
}
},
"description": "The schedule value"
},
"local_library_id": {
"type": "integer",
"format": "int32",
"description": "Local Library Id"
},
"is_onlinerepository_report": {
"type": "boolean",
"description": "Is Onlinerepository Report"
},
"get_reportfield_values": {
"type": "string",
"description": "Get Reportfield Values"
},
"get_reportcondition_values": {
"type": "string",
"description": "Get Reportcondition Values"
},
"filter_lookup_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"label": {
"type": "string"
},
"isnew": {
"type": "boolean"
}
}
},
"description": "Filter Lookup Values"
},
"report": {
"type": "object",
"description": "The report value"
},
"previous_report": {
"type": "object",
"description": "Previous Report"
},
"_testonly": {
"type": "boolean",
"description": "The testonly value"
},
"_testchart": {
"type": "boolean",
"description": "The testchart value"
},
"_loadreportonly": {
"type": "boolean",
"description": "The loadreportonly value"
},
"_do_ai_analysis": {
"type": "boolean",
"description": "Do Ai Analysis"
},
"_print_preview": {
"type": "boolean",
"description": "Print Preview"
},
"_print_generate": {
"type": "boolean",
"description": "Print Generate"
},
"_xls_generate": {
"type": "boolean",
"description": "Xls Generate"
},
"_json_generate": {
"type": "boolean",
"description": "Json Generate"
},
"printhtml": {
"type": "string",
"description": "The printhtml value"
},
"pdf_attachment_id": {
"type": "integer",
"format": "int32",
"description": "Pdf Attachment Id"
},
"xls_attachment_id": {
"type": "integer",
"format": "int32",
"description": "Xls Attachment Id"
},
"xls_attachment_link": {
"type": "string",
"description": "Xls Attachment Link"
},
"csv_attachment_id": {
"type": "integer",
"format": "int32",
"description": "Csv Attachment Id"
},
"csv_attachment_link": {
"type": "string",
"description": "Csv Attachment Link"
},
"json_attachment_id": {
"type": "integer",
"format": "int32",
"description": "Json Attachment Id"
},
"json_attachment_link": {
"type": "string",
"description": "Json Attachment Link"
},
"pdftemplate_id": {
"type": "integer",
"format": "int32",
"description": "Pdftemplate Id"
},
"pdftemplate_name": {
"type": "string",
"description": "Pdftemplate Name"
},
"pdftemplate": {
"type": "object",
"description": "The pdftemplate value"
},
"chart_base64": {
"type": "string",
"description": "Chart Base64"
},
"customise_table_html": {
"type": "boolean",
"description": "Customise Table Html"
},
"report_table_html": {
"type": "string",
"description": "Report Table Html"
},
"report_table_row_html": {
"type": "string",
"description": "Report Table Row Html"
},
"report_table_group_html": {
"type": "string",
"description": "Report Table Group Html"
},
"report_table_total_html": {
"type": "string",
"description": "Report Table Total Html"
},
"report_table_autosize_width": {
"type": "boolean",
"description": "Report Table Autosize Width"
},
"alreadyconverted": {
"type": "boolean",
"description": "The alreadyconverted value"
},
"invoice_id": {
"type": "integer",
"format": "int32",
"description": "Invoice Id"
},
"quote_id": {
"type": "integer",
"format": "int32",
"description": "Quote Id"
},
"consignment_id": {
"type": "integer",
"format": "int32",
"description": "Consignment Id"
},
"contract_id": {
"type": "integer",
"format": "int32",
"description": "Contract Id"
},
"purchase_order_id": {
"type": "integer",
"format": "int32",
"description": "Purchase Order Id"
},
"sales_order_id": {
"type": "integer",
"format": "int32",
"description": "Sales Order Id"
},
"asset_id": {
"type": "integer",
"format": "int32",
"description": "Asset Id"
},
"bookmarked": {
"type": "boolean",
"description": "The bookmarked value"
},
"report_access_token": {
"type": "string",
"description": "Report Access Token"
},
"colourpallette": {
"type": "string",
"description": "The colourpallette value"
},
"client_id": {
"type": "integer",
"format": "int32",
"description": "Client Id"
},
"show_top_only": {
"type": "boolean",
"description": "Show Top Only"
},
"top_count": {
"type": "integer",
"format": "int32",
"description": "Top Count"
},
"show_trendline": {
"type": "boolean",
"description": "Show Trendline"
},
"label_display_type": {
"type": "integer",
"format": "int32",
"description": "Label Display Type"
},
"show_datavalues": {
"type": "boolean",
"description": "Show Datavalues"
},
"format_values_as_currency": {
"type": "boolean",
"description": "Format Values As Currency"
},
"currency_symbol": {
"type": "string",
"description": "Currency Symbol"
},
"series": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"report_id": {
"type": "integer"
},
"report_name": {
"type": "string"
},
"widget_id": {
"type": "integer"
},
"seriestype": {
"type": "integer"
},
"yaxis": {
"type": "string"
},
"seq": {
"type": "integer"
},
"_warning": {
"type": "string"
}
}
},
"description": "The series value"
},
"colours": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"report_id": {
"type": "integer"
},
"widget_id": {
"type": "integer"
},
"colour": {
"type": "string"
},
"min_threshold": {
"type": "integer"
},
"name": {
"type": "string"
},
"_warning": {
"type": "string"
}
}
},
"description": "The colours value"
},
"ticket_id": {
"type": "integer",
"format": "int32",
"description": "Ticket Id"
},
"_warning": {
"type": "string",
"description": "The warning value"
},
"report_comparison": {
"type": "integer",
"format": "int32",
"description": "Report Comparison"
},
"chart_comparison": {
"type": "integer",
"format": "int32",
"description": "Chart Comparison"
},
"_run_prompt": {
"type": "boolean",
"description": "Run Prompt"
},
"_check_prompt": {
"type": "boolean",
"description": "Check Prompt"
},
"ai_prompt": {
"type": "string",
"description": "Ai Prompt"
},
"ai_threadid": {
"type": "string",
"description": "Ai Threadid"
},
"ai_runid": {
"type": "string",
"description": "Ai Runid"
},
"assistant_request": {
"type": "object",
"description": "Assistant Request"
},
"publish_type": {
"type": "integer",
"format": "int32",
"description": "Publish Type"
},
"apply_query_builder_perms": {
"type": "boolean",
"description": "Apply Query Builder Perms"
},
"last_run_date": {
"type": "string",
"format": "date-time",
"description": "Last Run Date"
},
"ai_user_prompt": {
"type": "string",
"description": "Ai User Prompt"
},
"ai_analysis": {
"type": "string",
"description": "Ai Analysis"
},
"ai_analysis_generation_datetime": {
"type": "string",
"format": "date-time",
"description": "Ai Analysis Generation Datetime"
},
"online_id": {
"type": "integer",
"format": "int32",
"description": "Online Id"
},
"online_datasource_id": {
"type": "integer",
"format": "int32",
"description": "Online Datasource Id"
},
"guide_html": {
"type": "string",
"description": "Guide Html"
},
"client_page_size": {
"type": "integer",
"format": "int32",
"description": "Client Page Size"
},
"forecast_id": {
"type": "integer",
"format": "int32",
"description": "Forecast Id"
},
"show_forecast_table": {
"type": "boolean",
"description": "Show Forecast Table"
},
"show_forecast_chart": {
"type": "boolean",
"description": "Show Forecast Chart"
},
"_refreshforecast": {
"type": "boolean",
"description": "The refreshforecast value"
},
"chart_padding": {
"type": "integer",
"format": "int32",
"description": "Chart Padding"
},
"data_label_min": {
"type": "number",
"format": "double",
"description": "Data Label Min"
},
"access_control": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"entity": {
"type": "string"
},
"entity_id": {
"type": "integer"
},
"type": {
"type": "integer"
},
"agent_id": {
"type": "integer"
},
"user_id": {
"type": "integer"
},
"role_id": {
"type": "integer"
},
"team_id": {
"type": "integer"
},
"team_guid": {
"type": "string"
},
"department_id": {
"type": "integer"
},
"department_guid": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "integer"
},
"_warning": {
"type": "string"
},
"entity_name": {
"type": "string"
},
"entity_text_id": {
"type": "string"
}
}
},
"description": "Access Control"
},
"access_control_level": {
"type": "integer",
"format": "int32",
"description": "Access Control Level"
},
"run_ai_analysis_before_schedule": {
"type": "boolean",
"description": "Run Ai Analysis Before Schedule"
},
"reports": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"description": "The reports value"
},
"date_created": {
"type": "string",
"format": "date-time",
"description": "Date Created"
},
"created_by": {
"type": "integer",
"format": "int32",
"description": "Created By"
},
"last_updated": {
"type": "string",
"format": "date-time",
"description": "Last Updated"
},
"last_updated_by": {
"type": "integer",
"format": "int32",
"description": "Last Updated By"
},
"group_id": {
"type": "integer",
"format": "int32",
"description": "Group Id"
},
"group_name": {
"type": "string",
"description": "Group Name"
},
"description": {
"type": "string",
"description": "The description value"
},
"type": {
"type": "integer",
"format": "int32",
"description": "The type value"
},
"datasource_id": {
"type": "integer",
"format": "int32",
"description": "Datasource Id"
},
"datasource_guid": {
"type": "string",
"format": "uuid",
"description": "Datasource Guid"
},
"restrictaccess": {
"type": "boolean",
"description": "The restrictaccess value"
},
"systemreportid": {
"type": "integer",
"format": "int32",
"description": "The systemreportid value"
},
"mainentity": {
"type": "string",
"description": "The mainentity value"
},
"canbeaccessedbyallusers": {
"type": "boolean",
"description": "The canbeaccessedbyallusers value"
},
"_canupdate": {
"type": "boolean",
"description": "The canupdate value"
},
"apiquery_id": {
"type": "integer",
"format": "int32",
"description": "Apiquery Id"
}
}
},
"description": "Request body"
}
},
"required": [
"PCID"
]
}
```
***
## haloitsm\_knowledge\_delete\_feedback\_by\_id
DELETE /Feedback/\{id}
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------ |
| `id` | integer | Yes | — | The id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## haloitsm\_knowledge\_delete\_kbarticle\_by\_id
DELETE /KBArticle/\{id}
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------ |
| `id` | integer | Yes | — | The id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## haloitsm\_knowledge\_delete\_report\_by\_id
DELETE /Report/\{id}
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------ |
| `id` | integer | Yes | — | The id value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## haloitsm\_knowledge\_get\_feedback\_by\_id
Get one Feedback
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------- | -------- | ------- | ------------------------ |
| `id` | integer | Yes | — | The id value |
| `clearcomment` | boolean | No | — | The clearcomment value |
| `includedetails` | boolean | No | — | The includedetails value |
| `key` | string | No | — | The key value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The id value"
},
"clearcomment": {
"type": "boolean",
"description": "The clearcomment value"
},
"includedetails": {
"type": "boolean",
"description": "The includedetails value"
},
"key": {
"type": "string",
"description": "The key value"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## haloitsm\_knowledge\_get\_kbarticle\_by\_id
Get one KBEntry
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------- | -------- | ------- | --------------------------------------------- |
| `id` | integer | Yes | — | The id value |
| `includedetails` | boolean | No | — | (bool) Include extra objects in the response. |
| `language_code` | string | No | — | Language Code |
| `language_override` | string | No | — | Language Override |
| `organisation_id` | integer | No | — | Organisation Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The id value"
},
"includedetails": {
"type": "boolean",
"description": "(bool) Include extra objects in the response."
},
"language_code": {
"type": "string",
"description": "Language Code"
},
"language_override": {
"type": "string",
"description": "Language Override"
},
"organisation_id": {
"type": "integer",
"description": "Organisation Id"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## haloitsm\_knowledge\_get\_report\_by\_id
Get one AnalyzerProfile
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------------- | ------- | -------- | ------- | ---------------------------------- |
| `id` | integer | Yes | — | The id value |
| `client_id` | integer | No | — | Client Id |
| `clientname` | string | No | — | The clientname value |
| `dashboard_id` | integer | No | — | Dashboard Id |
| `dashboard_published_id` | string | No | — | Dashboard Published Id |
| `dontloadsystemreport` | boolean | No | — | The dontloadsystemreport value |
| `getcompositetoken` | boolean | No | — | The getcompositetoken value |
| `includedetails` | boolean | No | — | The includedetails value |
| `invoice_id` | integer | No | — | Invoice Id |
| `loadreport` | boolean | No | — | The loadreport value |
| `report_access_token` | string | No | — | Report Access Token |
| `reportingperiod` | integer | No | — | The reportingperiod value |
| `reportingperiodenddate` | string | No | — | The reportingperiodenddate value |
| `reportingperiodstartdate` | string | No | — | The reportingperiodstartdate value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The id value"
},
"client_id": {
"type": "integer",
"description": "Client Id"
},
"clientname": {
"type": "string",
"description": "The clientname value"
},
"dashboard_id": {
"type": "integer",
"description": "Dashboard Id"
},
"dashboard_published_id": {
"type": "string",
"description": "Dashboard Published Id"
},
"dontloadsystemreport": {
"type": "boolean",
"description": "The dontloadsystemreport value"
},
"getcompositetoken": {
"type": "boolean",
"description": "The getcompositetoken value"
},
"includedetails": {
"type": "boolean",
"description": "The includedetails value"
},
"invoice_id": {
"type": "integer",
"description": "Invoice Id"
},
"loadreport": {
"type": "boolean",
"description": "The loadreport value"
},
"report_access_token": {
"type": "string",
"description": "Report Access Token"
},
"reportingperiod": {
"type": "integer",
"description": "The reportingperiod value"
},
"reportingperiodenddate": {
"type": "string",
"description": "The reportingperiodenddate value"
},
"reportingperiodstartdate": {
"type": "string",
"description": "The reportingperiodstartdate value"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## haloitsm\_knowledge\_list\_feedback
GET /Feedback
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## haloitsm\_knowledge\_list\_feedback\_feedback\_message
GET /Feedback/FeedbackMessage
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## haloitsm\_knowledge\_list\_kbarticle
List of KBEntry
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `activeinactive` | string | No | — | (string) Filter on active/inactive assets - comma seperated, first value being true or false for active, second for inactive. |
| `advanced_search` | string | No | — | Advanced Search |
| `articletype` | string | No | — | (string) Filter on article type, comma seperated. |
| `client_id` | integer | No | — | (int) Filters by the specified client. |
| `count` | integer | No | — | (int) Number of Knowledge Base Entries to return in the response. |
| `device_id` | integer | No | — | Device Id |
| `faqlists` | string | No | — | (int) Filters response based on the Knowledge Base Article FAQ lists. |
| `includeactive` | boolean | No | — | (bool) Include active Knowledge Base Entries in the response. |
| `includeinactive` | boolean | No | — | (bool) Include inactive Knowledge Base Entries in the response. |
| `key` | string | No | — | (string) Filters response based on the knowledge base key. |
| `language_code` | string | No | — | Language Code |
| `language_override` | string | No | — | Language Override |
| `needsreview` | string | No | — | (string) Filter on Knowdledge Base Articles that are past their next review date. |
| `order` | string | No | — | (string) The name of the field to order by first. |
| `order2` | string | No | — | (string) The name of the field to order by second. |
| `order3` | string | No | — | (string) The name of the field to order by third. |
| `order4` | string | No | — | (string) The name of the field to order by fourth. |
| `order5` | string | No | — | (string) The name of the field to order by fifth. |
| `orderdesc` | boolean | No | — | (bool) Whether to order ascending or descending on first order. |
| `orderdesc2` | boolean | No | — | (bool) Whether to order ascending or descending on second order. |
| `orderdesc3` | boolean | No | — | (bool) Whether to order ascending or descending on third order. |
| `orderdesc4` | boolean | No | — | (bool) Whether to order ascending or descending on fourth order. |
| `orderdesc5` | boolean | No | — | (bool) Whether to order ascending or descending on fifth order. |
| `organisation_id` | integer | No | — | (int) Filters by Knowdledge Base Articles belonging to a particular organisation. |
| `page_no` | integer | No | — | (int) When using Pagination, the page number to return. |
| `page_size` | integer | No | — | (int) When using Pagination, the size of the page. |
| `pageinate` | boolean | No | — | (bool) Whether to use Pagination in the response. |
| `related_to` | integer | No | — | (int) Filters response based on the related Knowledge Base Article. |
| `related_to_ticket` | integer | No | — | (int) Filters response based on the related ticket. |
| `search` | string | No | — | (string) Filters response based on the search string. |
| `site_id` | integer | No | — | (int) Filters by the specified site. |
| `type` | integer | No | — | (int) Filters response based on the Knowledge Base Article type. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"activeinactive": {
"type": "string",
"description": "(string) Filter on active/inactive assets - comma seperated, first value being true or false for active, second for inactive."
},
"advanced_search": {
"type": "string",
"description": "Advanced Search"
},
"articletype": {
"type": "string",
"description": "(string) Filter on article type, comma seperated."
},
"client_id": {
"type": "integer",
"description": "(int) Filters by the specified client."
},
"count": {
"type": "integer",
"description": "(int) Number of Knowledge Base Entries to return in the response."
},
"device_id": {
"type": "integer",
"description": "Device Id"
},
"faqlists": {
"type": "string",
"description": "(int) Filters response based on the Knowledge Base Article FAQ lists."
},
"includeactive": {
"type": "boolean",
"description": "(bool) Include active Knowledge Base Entries in the response."
},
"includeinactive": {
"type": "boolean",
"description": "(bool) Include inactive Knowledge Base Entries in the response."
},
"key": {
"type": "string",
"description": "(string) Filters response based on the knowledge base key."
},
"language_code": {
"type": "string",
"description": "Language Code"
},
"language_override": {
"type": "string",
"description": "Language Override"
},
"needsreview": {
"type": "string",
"description": "(string) Filter on Knowdledge Base Articles that are past their next review date."
},
"order": {
"type": "string",
"description": "(string) The name of the field to order by first."
},
"order2": {
"type": "string",
"description": "(string) The name of the field to order by second."
},
"order3": {
"type": "string",
"description": "(string) The name of the field to order by third."
},
"order4": {
"type": "string",
"description": "(string) The name of the field to order by fourth."
},
"order5": {
"type": "string",
"description": "(string) The name of the field to order by fifth."
},
"orderdesc": {
"type": "boolean",
"description": "(bool) Whether to order ascending or descending on first order."
},
"orderdesc2": {
"type": "boolean",
"description": "(bool) Whether to order ascending or descending on second order."
},
"orderdesc3": {
"type": "boolean",
"description": "(bool) Whether to order ascending or descending on third order."
},
"orderdesc4": {
"type": "boolean",
"description": "(bool) Whether to order ascending or descending on fourth order."
},
"orderdesc5": {
"type": "boolean",
"description": "(bool) Whether to order ascending or descending on fifth order."
},
"organisation_id": {
"type": "integer",
"description": "(int) Filters by Knowdledge Base Articles belonging to a particular organisation."
},
"page_no": {
"type": "integer",
"description": "(int) When using Pagination, the page number to return."
},
"page_size": {
"type": "integer",
"description": "(int) When using Pagination, the size of the page."
},
"pageinate": {
"type": "boolean",
"description": "(bool) Whether to use Pagination in the response."
},
"related_to": {
"type": "integer",
"description": "(int) Filters response based on the related Knowledge Base Article."
},
"related_to_ticket": {
"type": "integer",
"description": "(int) Filters response based on the related ticket."
},
"search": {
"type": "string",
"description": "(string) Filters response based on the search string."
},
"site_id": {
"type": "integer",
"description": "(int) Filters by the specified site."
},
"type": {
"type": "integer",
"description": "(int) Filters response based on the Knowledge Base Article type."
}
},
"required": [
"PCID"
]
}
```
***
## haloitsm\_knowledge\_list\_report
List of AnalyzerProfile
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | ------- | -------- | ------- | -------------------------- |
| `agentrestriction` | integer | No | — | The agentrestriction value |
| `chartonly` | boolean | No | — | The chartonly value |
| `clientname` | string | No | — | The clientname value |
| `count` | integer | No | — | The count value |
| `includepublished` | boolean | No | — | The includepublished value |
| `order` | string | No | — | The order value |
| `order2` | string | No | — | The order2 value |
| `order3` | string | No | — | The order3 value |
| `order4` | string | No | — | The order4 value |
| `order5` | string | No | — | The order5 value |
| `orderdesc` | boolean | No | — | The orderdesc value |
| `orderdesc2` | boolean | No | — | The orderdesc2 value |
| `orderdesc3` | boolean | No | — | The orderdesc3 value |
| `orderdesc4` | boolean | No | — | The orderdesc4 value |
| `orderdesc5` | boolean | No | — | The orderdesc5 value |
| `page_no` | integer | No | — | Page No |
| `page_size` | integer | No | — | Number of results per page |
| `pageinate` | boolean | No | — | The pageinate value |
| `reportgroup_id` | integer | No | — | Reportgroup Id |
| `search` | string | No | — | The search value |
| `type` | integer | No | — | The type value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"agentrestriction": {
"type": "integer",
"description": "The agentrestriction value"
},
"chartonly": {
"type": "boolean",
"description": "The chartonly value"
},
"clientname": {
"type": "string",
"description": "The clientname value"
},
"count": {
"type": "integer",
"description": "The count value"
},
"includepublished": {
"type": "boolean",
"description": "The includepublished value"
},
"order": {
"type": "string",
"description": "The order value"
},
"order2": {
"type": "string",
"description": "The order2 value"
},
"order3": {
"type": "string",
"description": "The order3 value"
},
"order4": {
"type": "string",
"description": "The order4 value"
},
"order5": {
"type": "string",
"description": "The order5 value"
},
"orderdesc": {
"type": "boolean",
"description": "The orderdesc value"
},
"orderdesc2": {
"type": "boolean",
"description": "The orderdesc2 value"
},
"orderdesc3": {
"type": "boolean",
"description": "The orderdesc3 value"
},
"orderdesc4": {
"type": "boolean",
"description": "The orderdesc4 value"
},
"orderdesc5": {
"type": "boolean",
"description": "The orderdesc5 value"
},
"page_no": {
"type": "integer",
"description": "Page No"
},
"page_size": {
"type": "integer",
"description": "Number of results per page"
},
"pageinate": {
"type": "boolean",
"description": "The pageinate value"
},
"reportgroup_id": {
"type": "integer",
"description": "Reportgroup Id"
},
"search": {
"type": "string",
"description": "The search value"
},
"type": {
"type": "integer",
"description": "The type value"
}
},
"required": [
"PCID"
]
}
```
***
## haloitsm\_knowledge\_vote\_kbarticle\_vote
POST /KBArticle/vote
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | ------------ |
| `body` | object\[] | No | — | Request body |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"body": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "The id value"
},
"name": {
"type": "string",
"description": "The name value"
},
"description": {
"type": "string",
"description": "The description value"
},
"view_count": {
"type": "integer",
"format": "int32",
"description": "View Count"
},
"useful_count": {
"type": "integer",
"format": "int32",
"description": "Useful Count"
},
"notuseful_count": {
"type": "integer",
"format": "int32",
"description": "Notuseful Count"
},
"date_created": {
"type": "string",
"format": "date-time",
"description": "Date Created"
},
"date_edited": {
"type": "string",
"format": "date-time",
"description": "Date Edited"
},
"tag_string": {
"type": "string",
"description": "Tag String"
},
"inactive": {
"type": "boolean",
"description": "The inactive value"
},
"type": {
"type": "integer",
"format": "int32",
"description": "The type value"
},
"next_review_date": {
"type": "string",
"format": "date-time",
"description": "Next Review Date"
},
"customfields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"label": {
"type": "string"
},
"summary": {
"type": "string"
},
"type": {
"type": "integer"
},
"value": {},
"value_is_password_id": {
"type": "boolean"
},
"display": {
"type": "string"
},
"characterlimit": {
"type": "integer"
},
"characterlimittype": {
"type": "integer"
},
"inputtype": {
"type": "integer"
},
"copytochild": {
"type": "boolean"
},
"copytoparent": {
"type": "boolean"
},
"searchable": {
"type": "boolean"
},
"ordervalues": {
"type": "boolean"
},
"ordervaluesby": {
"type": "integer"
},
"database_lookup_id": {
"type": "integer"
},
"database_lookup_auto": {
"type": "boolean"
},
"database_lookup_triggers": {
"type": "array"
},
"third_party_name": {
"type": "string"
},
"extratype": {
"type": "integer"
},
"copytochildonupdate": {
"type": "boolean"
},
"copytograndchildonupdate": {
"type": "boolean"
},
"copytoparentonupdate": {
"type": "boolean"
},
"hyperlink": {
"type": "string"
},
"usage": {
"type": "integer"
},
"linked_table_id": {
"type": "integer"
},
"showondetailsscreen": {
"type": "boolean"
},
"third_party_value": {
"type": "string"
},
"custom_extra_table_id": {
"type": "integer"
},
"copytorelated": {
"type": "boolean"
},
"only_validate_on_creation": {
"type": "boolean"
},
"calculation": {
"type": "string"
},
"rounding": {
"type": "integer"
},
"validation_reasons": {
"type": "array"
},
"int_value_is_display": {
"type": "boolean"
},
"regex": {
"type": "string"
},
"onlyshowforagents": {
"type": "boolean"
},
"is_horizontal": {
"type": "boolean"
},
"copied": {
"type": "boolean"
},
"isencrypted": {
"type": "boolean"
},
"max_selection": {
"type": "integer"
},
"guid": {
"type": "string"
},
"selection_field_id": {
"type": "integer"
},
"variable_format_1": {
"type": "string"
},
"variable_format_2": {
"type": "string"
},
"validation_data": {
"type": "array"
},
"database_lookup_input": {
"type": "integer"
},
"table_data_entry_type": {
"type": "integer"
},
"showintable": {
"type": "boolean"
},
"table_height": {
"type": "integer"
},
"dont_delete_rows": {
"type": "boolean"
},
"table_matching_field": {
"type": "integer"
},
"new_storage_method": {
"type": "boolean"
},
"where_sql": {
"type": "string"
},
"load_type": {
"type": "integer"
},
"add_rows": {
"type": "boolean"
},
"delete_these_rows": {
"type": "array"
},
"showinpool": {
"type": "boolean"
},
"allow_pool_override": {
"type": "boolean"
},
"details_column_group": {
"type": "integer"
},
"add_row_per_value": {
"type": "boolean"
},
"store_in_fielddata": {
"type": "boolean"
},
"first_value_default": {
"type": "boolean"
},
"copytoparentnewticket": {
"type": "boolean"
}
}
},
"description": "The customfields value"
},
"limit_start_date": {
"type": "string",
"format": "date-time",
"description": "Limit Start Date"
},
"limit_end_date": {
"type": "string",
"format": "date-time",
"description": "Limit End Date"
},
"editor_type": {
"type": "integer",
"format": "int32",
"description": "Editor Type"
},
"kb_tags": {
"type": "string",
"description": "Kb Tags"
},
"agent_view_count": {
"type": "integer",
"format": "int32",
"description": "Agent View Count"
},
"confluence_url": {
"type": "string",
"description": "Confluence Url"
},
"search_score": {
"type": "number",
"format": "double",
"description": "Search Score"
},
"resolution_list": {
"type": "string",
"description": "Resolution List"
},
"link": {
"type": "string",
"description": "The link value"
},
"geo_restrictions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"table_id": {
"type": "integer"
},
"entity_id": {
"type": "integer"
},
"country_code": {
"type": "string"
},
"continent_code": {
"type": "string"
},
"exclude": {
"type": "boolean"
}
}
},
"description": "Geo Restrictions"
},
"resolution": {
"type": "string",
"description": "The resolution value"
},
"creator_id": {
"type": "integer",
"format": "int32",
"description": "Creator Id"
},
"creator_name": {
"type": "string",
"description": "Creator Name"
},
"editor_id": {
"type": "integer",
"format": "int32",
"description": "Editor Id"
},
"editor_name": {
"type": "string",
"description": "Editor Name"
},
"xrefkbentry": {
"type": "integer",
"format": "int32",
"description": "The xrefkbentry value"
},
"xreftype": {
"type": "integer",
"format": "int32",
"description": "The xreftype value"
},
"xrefdoc": {
"type": "integer",
"format": "int32",
"description": "The xrefdoc value"
},
"ticket_id": {
"type": "integer",
"format": "int32",
"description": "Ticket Id"
},
"description_html": {
"type": "string",
"description": "Description Html"
},
"description_markdown": {
"type": "string",
"description": "Description Markdown"
},
"resolution_html": {
"type": "string",
"description": "Resolution Html"
},
"resolution_markdown": {
"type": "string",
"description": "Resolution Markdown"
},
"internalmemoagent": {
"type": "string",
"description": "The internalmemoagent value"
},
"internalmemoagenthtml": {
"type": "string",
"description": "The internalmemoagenthtml value"
},
"internalmemomarkdown": {
"type": "string",
"description": "The internalmemomarkdown value"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"text": {
"type": "string"
},
"add_to_kbid": {
"type": "integer"
},
"add_to_ctid": {
"type": "integer"
},
"add_to_stid": {
"type": "integer"
},
"_warning": {
"type": "string"
},
"add_to_stdid": {
"type": "integer"
},
"type": {
"type": "integer"
}
}
},
"description": "The tags value"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"copytochildonupdate": {
"type": "boolean"
},
"id": {
"type": "integer"
},
"rtid": {
"type": "integer"
},
"usage": {
"type": "integer"
},
"fieldid": {
"type": "integer"
},
"fieldguid": {
"type": "string"
},
"seq": {
"type": "integer"
},
"tableid": {
"type": "integer"
},
"tableguid": {
"type": "string"
},
"groupid": {
"type": "integer"
},
"groupguid": {
"type": "string"
},
"endusernew": {
"type": "integer"
},
"enduserdetail": {
"type": "integer"
},
"enduserdetailrejected": {
"type": "integer"
},
"technew": {
"type": "integer"
},
"techdetail": {
"type": "integer"
},
"fieldname": {
"type": "string"
},
"fieldinfo": {
"type": "object"
},
"visibility_conditions": {
"type": "array"
},
"visibility_conditions_value": {
"type": "array"
},
"group_visibility_conditions": {
"type": "array"
},
"value_restrictions": {
"type": "array"
},
"group": {
"type": "object"
},
"technewlocation": {
"type": "integer"
},
"restrictupdate": {
"type": "integer"
},
"update_restrictions": {
"type": "array"
},
"techtab_id": {
"type": "integer"
},
"techtab_name": {
"type": "string"
},
"showdependency": {
"type": "boolean"
},
"canupdate": {
"type": "boolean"
},
"_warning": {
"type": "string"
},
"override_fieldname": {
"type": "string"
},
"override_action_fieldname": {
"type": "string"
},
"boldlabelandvalue": {
"type": "boolean"
},
"enduserdetailhideifempty": {
"type": "boolean"
},
"techdetailhideifempty": {
"type": "boolean"
},
"copytochild": {
"type": "boolean"
},
"copytorelated": {
"type": "boolean"
},
"restrictread": {
"type": "integer"
},
"read_restrictions": {
"type": "array"
},
"techtab_columns": {
"type": "integer"
},
"chat_message": {
"type": "string"
},
"techaction": {
"type": "integer"
},
"enduseraction": {
"type": "integer"
},
"endusercheckboxmandatory": {
"type": "boolean"
},
"translations": {
"type": "array"
},
"display_type": {
"type": "integer"
},
"copytoparent": {
"type": "boolean"
},
"copytoparentonupdate": {
"type": "boolean"
},
"agentcheckboxmandatory": {
"type": "boolean"
},
"agentbookingdetail": {
"type": "integer"
},
"copytoparentnewticket": {
"type": "boolean"
}
}
},
"description": "The fields value"
},
"teams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"guid": {
"type": "string"
},
"intent": {
"type": "string"
},
"name": {
"type": "string"
},
"sequence": {
"type": "integer"
},
"forrequests": {
"type": "boolean"
},
"foropps": {
"type": "boolean"
},
"forprojects": {
"type": "boolean"
},
"ticket_count": {
"type": "integer"
},
"department_id": {
"type": "integer"
},
"department_name": {
"type": "string"
},
"org_team_name": {
"type": "string"
},
"inactive": {
"type": "boolean"
},
"override_column_id": {
"type": "integer"
},
"managers": {
"type": "array"
},
"teamphotopath": {
"type": "string"
},
"last_modified": {
"type": "string"
},
"hide_agents_in_tree_if_no_tickets": {
"type": "boolean"
},
"timesheet_approver": {
"type": "integer"
},
"timesheet_approver_name": {
"type": "string"
},
"concurrent_lic_limit": {
"type": "integer"
},
"workinghoursbeforealert": {
"type": "number"
},
"emailaddress": {
"type": "string"
},
"addtoallagents": {
"type": "boolean"
},
"allowlivechat": {
"type": "boolean"
},
"rtid": {
"type": "integer"
},
"agents": {
"type": "array"
},
"organisation_id": {
"type": "integer"
},
"cannedtext": {
"type": "array"
},
"templates": {
"type": "array"
},
"allowall_category1": {
"type": "boolean"
},
"allowed_category1": {
"type": "array"
},
"allowall_category2": {
"type": "boolean"
},
"allowed_category2": {
"type": "array"
},
"allowall_category3": {
"type": "boolean"
},
"allowed_category3": {
"type": "array"
},
"allowall_category4": {
"type": "boolean"
},
"includeinloadbalance": {
"type": "boolean"
},
"allowed_category4": {
"type": "array"
},
"override_column_name": {
"type": "string"
},
"messagegroup_id": {
"type": "integer"
},
"_warning": {
"type": "string"
},
"_canupdate": {
"type": "boolean"
},
"_canupdate2": {
"type": "boolean"
},
"main_email_address": {
"type": "string"
},
"phone_number": {
"type": "string"
},
"timezone": {
"type": "string"
},
"alternative_name": {
"type": "string"
},
"logo": {
"type": "string"
},
"dontsendsurvey": {
"type": "boolean"
},
"team_note": {
"type": "string"
},
"booking_workday_id": {
"type": "integer"
},
"booking_workday_name": {
"type": "string"
},
"recurring_shifts": {
"type": "array"
},
"third_party_migration_id": {
"type": "string"
},
"enable_teams_shifts": {
"type": "boolean"
},
"load_balance_schedule": {
"type": "object"
},
"load_balance_interval": {
"type": "integer"
},
"load_balance_max_tickets": {
"type": "integer"
},
"load_balance_on_schedule": {
"type": "boolean"
},
"load_balance_schedule_frequency": {
"type": "integer"
},
"load_balance_max_tickets_this_team_only": {
"type": "boolean"
},
"load_balance_max_tickets_agent_specific": {
"type": "boolean"
},
"auto_load_balance_on_close": {
"type": "boolean"
},
"load_balance_agent_limits": {
"type": "array"
},
"new_cab_guid": {
"type": "string"
},
"new_external_link": {
"type": "object"
},
"_match_thirdparty_id": {
"type": "string"
},
"_match_additional_id": {
"type": "string"
},
"_match_integration_id": {
"type": "integer"
},
"_match_integration_name": {
"type": "string"
},
"_isimport": {
"type": "boolean"
},
"_importtype": {
"type": "string"
},
"import_details_id": {
"type": "integer"
},
"use": {
"type": "string"
},
"department_guid": {
"type": "string"
},
"homescreendashboardid": {
"type": "integer"
},
"homescreendashboardname": {
"type": "string"
},
"customfields": {
"type": "array"
},
"mailbox_override": {
"type": "integer"
}
}
},
"description": "The teams value"
},
"your_vote": {
"type": "integer",
"format": "int32",
"description": "Your Vote"
},
"showforall": {
"type": "boolean",
"description": "The showforall value"
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"filename": {
"type": "string"
},
"datecreated": {
"type": "string"
},
"note": {
"type": "string"
},
"filesize": {
"type": "integer"
},
"type": {
"type": "integer"
},
"unique_id": {
"type": "integer"
},
"desc": {
"type": "string"
},
"isimage": {
"type": "boolean"
},
"showforusers": {
"type": "boolean"
},
"showonchild": {
"type": "boolean"
},
"showonrelated": {
"type": "boolean"
},
"data_base64": {
"type": "string"
},
"download_url": {
"type": "string"
},
"third_party_token": {
"type": "string"
},
"third_party_id": {
"type": "string"
},
"already_posted": {
"type": "boolean"
},
"last_updated": {
"type": "string"
},
"faultid": {
"type": "integer"
},
"_isimport": {
"type": "boolean"
},
"_importtype": {
"type": "string"
},
"s3url": {
"type": "string"
},
"att_link": {
"type": "string"
},
"child_count": {
"type": "integer"
},
"parent_id": {
"type": "integer"
},
"linked_version_id": {
"type": "integer"
},
"allow_anon_upload": {
"type": "boolean"
},
"tickettype_id": {
"type": "integer"
},
"tickettype_guid": {
"type": "string"
},
"validate_guid": {
"type": "string"
},
"import_parentid": {
"type": "string"
},
"folder_hierarchy": {
"type": "string"
},
"access_control_level": {
"type": "integer"
},
"is_s3": {
"type": "boolean"
}
}
},
"description": "The attachments value"
},
"_isimport": {
"type": "boolean",
"description": "The isimport value"
},
"importfaqs": {
"type": "string",
"description": "The importfaqs value"
},
"last_review_date": {
"type": "string",
"format": "date-time",
"description": "Last Review Date"
},
"reviewed_by": {
"type": "integer",
"format": "int32",
"description": "Reviewed By"
},
"reviewer_name": {
"type": "string",
"description": "Reviewer Name"
},
"_reviewed": {
"type": "boolean",
"description": "The reviewed value"
},
"new_version_from_id": {
"type": "integer",
"format": "int32",
"description": "New Version From Id"
},
"other_versions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"view_count": {
"type": "integer"
},
"useful_count": {
"type": "integer"
},
"notuseful_count": {
"type": "integer"
},
"date_created": {
"type": "string"
},
"date_edited": {
"type": "string"
},
"tag_string": {
"type": "string"
},
"inactive": {
"type": "boolean"
},
"type": {
"type": "integer"
},
"next_review_date": {
"type": "string"
},
"customfields": {
"type": "array"
},
"limit_start_date": {
"type": "string"
},
"limit_end_date": {
"type": "string"
},
"editor_type": {
"type": "integer"
},
"kb_tags": {
"type": "string"
},
"agent_view_count": {
"type": "integer"
},
"confluence_url": {
"type": "string"
},
"search_score": {
"type": "number"
},
"resolution_list": {
"type": "string"
},
"link": {
"type": "string"
},
"geo_restrictions": {
"type": "array"
},
"use": {
"type": "string"
},
"key": {
"type": "integer"
},
"table": {
"type": "integer"
},
"ticket_template_id": {
"type": "integer"
},
"faqdseq": {
"type": "integer"
},
"faqliststr": {
"type": "string"
},
"faqlists": {
"type": "array"
},
"description_list": {
"type": "string"
},
"key_copy": {
"type": "string"
},
"all_version_view_count": {
"type": "integer"
},
"search_count": {
"type": "integer"
},
"_importtypeid": {
"type": "integer"
},
"_importthirdpartyid": {
"type": "string"
},
"_importtype": {
"type": "string"
},
"new_external_link": {
"type": "object"
},
"import_details_id": {
"type": "integer"
},
"_isupdateimport": {
"type": "boolean"
},
"_match_thirdparty_id": {
"type": "string"
},
"_match_integration_id": {
"type": "integer"
},
"_match_integration_name": {
"type": "string"
},
"_match_integration_button_caption": {
"type": "string"
},
"_match_integration_button_url": {
"type": "string"
},
"_match_integration_button_icon": {
"type": "string"
}
}
},
"description": "Other Versions"
},
"servicenow_id": {
"type": "string",
"description": "Servicenow Id"
},
"import_attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"third_party_id": {
"type": "string"
},
"link": {
"type": "string"
},
"content_type": {
"type": "string"
},
"last_updated": {
"type": "string"
},
"id": {
"type": "integer"
},
"filename": {
"type": "string"
},
"datecreated": {
"type": "string"
},
"note": {
"type": "string"
},
"filesize": {
"type": "integer"
},
"type": {
"type": "integer"
},
"unique_id": {
"type": "integer"
},
"desc": {
"type": "string"
},
"isimage": {
"type": "boolean"
},
"data": {
"type": "string"
},
"ticket_id": {
"type": "integer"
},
"action_id": {
"type": "integer"
},
"outcome_id": {
"type": "integer"
},
"user_id": {
"type": "integer"
},
"agent_id": {
"type": "integer"
},
"attachmentaction_id": {
"type": "integer"
},
"_canupdate": {
"type": "boolean"
},
"guid": {
"type": "string"
},
"image_upload_id": {
"type": "integer"
},
"image_upload_key": {
"type": "string"
},
"file": {
"type": "string"
},
"_enduserportalpdfprint": {
"type": "boolean"
},
"anon_outcomeid": {
"type": "integer"
},
"has_scanned": {
"type": "boolean"
},
"_warning": {
"type": "string"
},
"_is_new_version": {
"type": "boolean"
},
"parent_name": {
"type": "string"
},
"parent_desc": {
"type": "string"
},
"version_count": {
"type": "integer"
},
"_alreadyuploaded": {
"type": "boolean"
},
"copy_from_id": {
"type": "integer"
},
"new_external_link": {
"type": "object"
},
"_match_thirdparty_id": {
"type": "string"
},
"_match_additional_id": {
"type": "string"
},
"_match_integration_id": {
"type": "integer"
},
"_match_integration_name": {
"type": "string"
},
"import_details_id": {
"type": "integer"
},
"external_links": {
"type": "array"
},
"access_control": {
"type": "array"
},
"_start_transcription": {
"type": "boolean"
},
"_transcription_started": {
"type": "boolean"
},
"_transcription_is_new_action": {
"type": "boolean"
},
"showforusers": {
"type": "boolean"
},
"showonchild": {
"type": "boolean"
},
"showonrelated": {
"type": "boolean"
},
"data_base64": {
"type": "string"
},
"download_url": {
"type": "string"
},
"third_party_token": {
"type": "string"
},
"already_posted": {
"type": "boolean"
},
"faultid": {
"type": "integer"
},
"_isimport": {
"type": "boolean"
},
"_importtype": {
"type": "string"
},
"s3url": {
"type": "string"
},
"att_link": {
"type": "string"
},
"child_count": {
"type": "integer"
},
"parent_id": {
"type": "integer"
},
"linked_version_id": {
"type": "integer"
},
"allow_anon_upload": {
"type": "boolean"
},
"tickettype_id": {
"type": "integer"
},
"tickettype_guid": {
"type": "string"
},
"validate_guid": {
"type": "string"
},
"import_parentid": {
"type": "string"
},
"folder_hierarchy": {
"type": "string"
},
"access_control_level": {
"type": "integer"
},
"is_s3": {
"type": "boolean"
}
}
},
"description": "Import Attachments"
},
"related_articles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"view_count": {
"type": "integer"
},
"useful_count": {
"type": "integer"
},
"notuseful_count": {
"type": "integer"
},
"date_created": {
"type": "string"
},
"date_edited": {
"type": "string"
},
"tag_string": {
"type": "string"
},
"inactive": {
"type": "boolean"
},
"type": {
"type": "integer"
},
"next_review_date": {
"type": "string"
},
"customfields": {
"type": "array"
},
"limit_start_date": {
"type": "string"
},
"limit_end_date": {
"type": "string"
},
"editor_type": {
"type": "integer"
},
"kb_tags": {
"type": "string"
},
"agent_view_count": {
"type": "integer"
},
"confluence_url": {
"type": "string"
},
"search_score": {
"type": "number"
},
"resolution_list": {
"type": "string"
},
"link": {
"type": "string"
},
"geo_restrictions": {
"type": "array"
},
"use": {
"type": "string"
},
"key": {
"type": "integer"
},
"table": {
"type": "integer"
},
"ticket_template_id": {
"type": "integer"
},
"faqdseq": {
"type": "integer"
},
"faqliststr": {
"type": "string"
},
"faqlists": {
"type": "array"
},
"description_list": {
"type": "string"
},
"key_copy": {
"type": "string"
},
"all_version_view_count": {
"type": "integer"
},
"search_count": {
"type": "integer"
},
"_importtypeid": {
"type": "integer"
},
"_importthirdpartyid": {
"type": "string"
},
"_importtype": {
"type": "string"
},
"new_external_link": {
"type": "object"
},
"import_details_id": {
"type": "integer"
},
"_isupdateimport": {
"type": "boolean"
},
"_match_thirdparty_id": {
"type": "string"
},
"_match_integration_id": {
"type": "integer"
},
"_match_integration_name": {
"type": "string"
},
"_match_integration_button_caption": {
"type": "string"
},
"_match_integration_button_url": {
"type": "string"
},
"_match_integration_button_icon": {
"type": "string"
}
}
},
"description": "Related Articles"
},
"your_comment": {
"type": "string",
"description": "Your Comment"
},
"freshdesk_id": {
"type": "string",
"description": "Freshdesk Id"
},
"freshdesk_folder_name": {
"type": "string",
"description": "Freshdesk Folder Name"
},
"freshdesk_category_name": {
"type": "string",
"description": "Freshdesk Category Name"
},
"translations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"language_id": {
"type": "integer"
},
"entity": {
"type": "string"
},
"fieldname": {
"type": "string"
},
"entity_id": {
"type": "integer"
},
"entity_id2": {
"type": "integer"
},
"entity_id3": {
"type": "integer"
},
"entity_textid": {
"type": "string"
},
"translation": {
"type": "string"
},
"_dotranslate": {
"type": "boolean"
},
"_translateonly": {
"type": "boolean"
},
"_isimport": {
"type": "boolean"
},
"default_translation": {
"type": "string"
},
"_warning": {
"type": "string"
}
}
},
"description": "The translations value"
},
"_print_generate": {
"type": "boolean",
"description": "Print Generate"
},
"printhtml": {
"type": "string",
"description": "The printhtml value"
},
"pdf_attachment_id": {
"type": "integer",
"format": "int32",
"description": "Pdf Attachment Id"
},
"pdftemplate_id": {
"type": "integer",
"format": "int32",
"description": "Pdftemplate Id"
},
"pdftemplate_name": {
"type": "string",
"description": "Pdftemplate Name"
},
"kbentryclientaccess": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"client_id": {
"type": "integer"
},
"client_name": {
"type": "string"
},
"kb_id": {
"type": "integer"
},
"_warning": {
"type": "string"
}
}
},
"description": "The kbentryclientaccess value"
},
"kbentrytoplevelaccess": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"toplevel_id": {
"type": "integer"
},
"toplevel_name": {
"type": "string"
},
"kb_id": {
"type": "integer"
},
"_warning": {
"type": "string"
}
}
},
"description": "The kbentrytoplevelaccess value"
},
"_warning": {
"type": "string",
"description": "The warning value"
},
"devices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"changeguid": {
"type": "string"
},
"intent": {
"type": "string"
},
"inventory_number": {
"type": "string"
},
"key_field": {
"type": "string"
},
"key_field2": {
"type": "string"
},
"key_field3": {
"type": "string"
},
"client_id": {
"type": "integer"
},
"client_name": {
"type": "string"
},
"site_id": {
"type": "integer"
},
"site_name": {
"type": "string"
},
"business_owner_id": {
"type": "integer"
},
"business_owner_name": {
"type": "string"
},
"business_owner_site": {
"type": "string"
},
"business_owner_client": {
"type": "string"
},
"business_owner_cab_id": {
"type": "integer"
},
"business_owner_cab_name": {
"type": "string"
},
"username": {
"type": "string"
},
"technical_owner_id": {
"type": "integer"
},
"technical_owner_name": {
"type": "string"
},
"technical_owner_cab_id": {
"type": "integer"
},
"technical_owner_cab_name": {
"type": "string"
},
"intune_default_site": {
"type": "integer"
},
"assettype_id": {
"type": "integer"
},
"assettype_name": {
"type": "string"
},
"colour": {
"type": "string"
},
"icon": {
"type": "string"
},
"warranty_end": {
"type": "string"
},
"inactive": {
"type": "boolean"
},
"is_primary_asset": {
"type": "boolean"
},
"parent_id": {
"type": "integer"
},
"lansweeper_parent_id": {
"type": "string"
},
"child_id": {
"type": "integer"
},
"sibling_id": {
"type": "boolean"
},
"contract_value": {
"type": "number"
},
"contract_ref": {
"type": "string"
},
"contract_id": {
"type": "integer"
},
"supplier_id": {
"type": "integer"
},
"supplier_name": {
"type": "string"
},
"manufacturer_id": {
"type": "integer"
},
"manufacturer_name": {
"type": "string"
},
"supplier_contract_id": {
"type": "integer"
},
"supplier_contract_ref": {
"type": "string"
},
"supplier_sla_id": {
"type": "integer"
},
"supplier_priority_id": {
"type": "integer"
},
"fields": {
"type": "array"
},
"customfields": {
"type": "array"
},
"relationship_id": {
"type": "integer"
},
"default_contract_value": {
"type": "number"
},
"itemstock_id": {
"type": "integer"
},
"item_id": {
"type": "integer"
},
"stock_date": {
"type": "string"
},
"non_consignable": {
"type": "boolean"
},
"reserved_salesorder_id": {
"type": "integer"
},
"reserved_salesorder_line_id": {
"type": "integer"
},
"matching_field": {
"type": "string"
},
"is_auto_picking_asset_tag": {
"type": "boolean"
},
"device42_id": {
"type": "integer"
},
"device42_url": {
"type": "string"
},
"related_services": {
"type": "string"
},
"technical_owner": {
"type": "string"
},
"business_owner": {
"type": "string"
},
"primary_asset_chart_json": {
"type": "string"
},
"criticality": {
"type": "integer"
},
"service_id": {
"type": "integer"
},
"key": {
"type": "integer"
},
"table": {
"type": "integer"
},
"use": {
"type": "string"
},
"device_number": {
"type": "integer"
},
"assettype_guid": {
"type": "string"
},
"owning_portfolio_name": {
"type": "string"
},
"owning_service_name": {
"type": "string"
},
"owning_businessapp_name": {
"type": "string"
},
"owning_ci_name": {
"type": "string"
},
"warranty_start": {
"type": "string"
},
"labour_warranty_start": {
"type": "string"
},
"labour_warranty_end": {
"type": "string"
},
"parent_guid": {
"type": "string"
},
"child_guid": {
"type": "string"
},
"status_id": {
"type": "integer"
},
"status_name": {
"type": "string"
},
"third_party_id": {
"type": "integer"
},
"sla_name": {
"type": "string"
},
"priority_name": {
"type": "string"
},
"latest_contract_ref": {
"type": "string"
},
"sequence": {
"type": "integer"
},
"ncentral_url": {
"type": "string"
},
"ncentral_remote_url": {
"type": "string"
},
"contract_end_date": {
"type": "string"
},
"atera_id": {
"type": "string"
},
"automate_id": {
"type": "integer"
},
"automate_url": {
"type": "string"
},
"connectwise_control_url": {
"type": "string"
},
"ninjarmm_id": {
"type": "integer"
},
"ninja_url": {
"type": "string"
},
"ninja_remote_url": {
"type": "string"
},
"syncro_url": {
"type": "string"
},
"syncroid": {
"type": "integer"
},
"itglue_url": {
"type": "string"
},
"defaultsequence": {
"type": "integer"
},
"service_ids": {
"type": "string"
},
"bulkcreated": {
"type": "boolean"
},
"bulkbillingperiod": {
"type": "integer"
},
"asset_field": {
"type": "string"
},
"datto_alternate_id": {
"type": "integer"
},
"syncro_id": {
"type": "string"
},
"domotz_id": {
"type": "string"
},
"snow_id": {
"type": "integer"
},
"passportal_id": {
"type": "integer"
},
"auvik_device_id": {
"type": "string"
},
"auvik_url": {
"type": "string"
},
"allowallstatus": {
"type": "boolean"
},
"allowed_status": {
"type": "array"
},
"allowallcustombuttons": {
"type": "boolean"
},
"allowed_custombuttons": {
"type": "array"
},
"datto_id": {
"type": "string"
},
"addigy_id": {
"type": "string"
},
"liongard_url": {
"type": "string"
},
"liongard_environmnet_id": {
"type": "integer"
},
"liongard_id": {
"type": "string"
},
"kaseya_id": {
"type": "string"
},
"iskaseyaagent": {
"type": "boolean"
},
"kaseyavsa_url": {
"type": "string"
},
"addigy_url": {
"type": "string"
},
"teamviewerid": {
"type": "string"
},
"serialization_user": {
"type": "integer"
},
"zabbix_id": {
"type": "string"
},
"zabbix_url": {
"type": "string"
},
"stockbin_name": {
"type": "string"
},
"issue_consignment_line_id": {
"type": "integer"
},
"item_name": {
"type": "string"
},
"datto_url": {
"type": "string"
},
"ncentral_details_id": {
"type": "integer"
},
"nable_id": {
"type": "string"
},
"connectwisecontrolid": {
"type": "string"
},
"_isimport": {
"type": "boolean"
},
"_importtype": {
"type": "string"
},
"workspace_id": {
"type": "string"
},
"workspace_url": {
"type": "string"
},
"intune_id": {
"type": "string"
},
"supplier_purchasedate": {
"type": "string"
},
"logicmonitor_id": {
"type": "string"
},
"barracudarmm_id": {
"type": "string"
},
"sla_id": {
"type": "integer"
},
"priority_id": {
"type": "integer"
},
"icinga_id": {
"type": "string"
},
"related_service_name": {
"type": "string"
},
"related_service_count": {
"type": "integer"
},
"connectwisermm_id": {
"type": "string"
},
"xensam_id": {
"type": "string"
},
"asset_type_priority": {
"type": "integer"
},
"snipeit_id": {
"type": "string"
},
"prometheus_id": {
"type": "string"
},
"dynatrace_id": {
"type": "string"
},
"vmworkspace_id": {
"type": "string"
},
"tanium_id": {
"type": "string"
},
"tenable_id": {
"type": "string"
},
"kandji_id": {
"type": "string"
},
"criticality_description": {
"type": "string"
},
"auvik_id": {
"type": "string"
},
"is_template": {
"type": "boolean"
},
"aws_id": {
"type": "string"
},
"manageengine_id": {
"type": "string"
},
"manageengine_customer_id": {
"type": "string"
},
"lastchangeofvaluedate": {
"type": "string"
},
"commissiondate": {
"type": "string"
},
"first_user_id": {
"type": "integer"
},
"changebackupexists": {
"type": "boolean"
},
"_isbatch": {
"type": "boolean"
},
"virima_id": {
"type": "string"
},
"service_guid": {
"type": "string"
},
"service_name": {
"type": "string"
},
"lansweeperid": {
"type": "string"
},
"eracent_id": {
"type": "string"
},
"changehistory_last_updated": {
"type": "string"
},
"changehistory_updated_by": {
"type": "string"
},
"changehistory_created_by": {
"type": "string"
},
"changehistory_created_date": {
"type": "string"
},
"auto_link": {
"type": "boolean"
},
"impact_statement": {
"type": "string"
},
"activity_statement": {
"type": "string"
},
"raynet_id": {
"type": "string"
},
"armis_id": {
"type": "string"
},
"kaseyavsax_id": {
"type": "string"
},
"diagram_field1": {
"type": "string"
},
"diagram_field2": {
"type": "string"
},
"diagram_field3": {
"type": "string"
},
"ci_type": {
"type": "integer"
},
"manually_linked_ticket": {
"type": "boolean"
},
"_importtypeid": {
"type": "integer"
},
"_importthirdpartyid": {
"type": "string"
},
"new_external_link": {
"type": "object"
},
"import_details_id": {
"type": "integer"
},
"_isupdateimport": {
"type": "boolean"
},
"_match_thirdparty_id": {
"type": "string"
},
"_match_integration_id": {
"type": "integer"
},
"_match_integration_name": {
"type": "string"
},
"_match_integration_button_caption": {
"type": "string"
},
"_match_integration_button_url": {
"type": "string"
},
"_match_integration_button_icon": {
"type": "string"
}
}
},
"description": "The devices value"
},
"faq_write": {
"type": "boolean",
"description": "Faq Write"
},
"new_external_link": {
"type": "object",
"description": "New External Link"
},
"_match_thirdparty_id": {
"type": "string",
"description": "Match Thirdparty Id"
},
"_match_additional_id": {
"type": "string",
"description": "Match Additional Id"
},
"_match_integration_id": {
"type": "integer",
"format": "int32",
"description": "Match Integration Id"
},
"_match_integration_name": {
"type": "string",
"description": "Match Integration Name"
},
"external_links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"table_id": {
"type": "integer"
},
"module_id": {
"type": "integer"
},
"integration_name": {
"type": "string"
},
"halo_id": {
"type": "integer"
},
"third_party_id": {
"type": "string"
},
"third_party_desc": {
"type": "string"
},
"third_party_type": {
"type": "string"
},
"third_party_url": {
"type": "string"
},
"third_party_assigned_to": {
"type": "string"
},
"third_party_count": {
"type": "integer"
},
"primary": {
"type": "boolean"
},
"halo_desc": {
"type": "string"
},
"halo_second_id": {
"type": "integer"
},
"halo_second_desc": {
"type": "string"
},
"extra_match_field": {
"type": "string"
},
"details_id": {
"type": "integer"
},
"third_party_secondary_id": {
"type": "string"
},
"_warning": {
"type": "string"
},
"third_party_status": {
"type": "string"
},
"third_party_priority": {
"type": "string"
},
"_match": {
"type": "boolean"
},
"populate_url": {
"type": "boolean"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"subscription_id": {
"type": "string"
},
"new_subscription_key": {
"type": "string"
},
"subscription_expiry": {
"type": "string"
},
"_webhookaction": {
"type": "integer"
},
"revisions": {
"type": "integer"
},
"dont_move_existing_assets": {
"type": "boolean"
},
"chat_message_count": {
"type": "integer"
},
"third_party_additional_id": {
"type": "string"
},
"description": {
"type": "string"
},
"update_existing_link": {
"type": "boolean"
},
"filters": {
"type": "array"
},
"parent_id": {
"type": "integer"
},
"child_links": {
"type": "array"
},
"url_for_linked_entity": {
"type": "string"
},
"url_for_linked_entity_caption": {
"type": "string"
},
"icon_for_linked_entity_caption": {
"type": "string"
}
}
},
"description": "External Links"
},
"wordpress_tags": {
"type": "object",
"description": "Wordpress Tags"
},
"wordpress_categories": {
"type": "object",
"description": "Wordpress Categories"
},
"importtags": {
"type": "string",
"description": "The importtags value"
},
"owners": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"article_id": {
"type": "integer"
},
"agent_id": {
"type": "integer"
},
"team_id": {
"type": "integer"
},
"name": {
"type": "string"
},
"owner_type": {
"type": "integer"
}
}
},
"description": "The owners value"
},
"search_index_sync_timestamp": {
"type": "string",
"format": "date-time",
"description": "Search Index Sync Timestamp"
},
"search_index_sync_batches": {
"type": "integer",
"format": "int32",
"description": "Search Index Sync Batches"
},
"kbpermalinks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"entity_name": {
"type": "string"
},
"entity_id": {
"type": "integer"
},
"published_guid": {
"type": "string"
},
"access_token": {
"type": "string"
},
"custom_path": {
"type": "string"
},
"publishedlink": {
"type": "string"
},
"_warning": {
"type": "string"
}
}
},
"description": "The kbpermalinks value"
},
"negativeFeedbackTicket": {
"type": "object",
"description": "Negative Feedback Ticket"
},
"generatetoken": {
"type": "boolean",
"description": "The generatetoken value"
},
"latestversion": {
"type": "integer",
"format": "int32",
"description": "The latestversion value"
},
"creator_userid": {
"type": "integer",
"format": "int32",
"description": "Creator Userid"
},
"permalink_type": {
"type": "integer",
"format": "int32",
"description": "Permalink Type"
},
"custom_permalink": {
"type": "string",
"description": "Custom Permalink"
},
"add_tags": {
"type": "boolean",
"description": "Add Tags"
},
"add_faq_lists": {
"type": "boolean",
"description": "Add Faq Lists"
},
"style_profile_links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"styleprofile_id": {
"type": "integer"
},
"entityid": {
"type": "integer"
},
"entityguid": {
"type": "string"
},
"entity_name": {
"type": "string"
},
"profile_name": {
"type": "string"
},
"precedence": {
"type": "integer"
},
"type": {
"type": "integer"
},
"_warning": {
"type": "string"
}
}
},
"description": "Style Profile Links"
},
"style_profile_rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"styleprofile_id": {
"type": "integer"
},
"selector": {
"type": "string"
},
"style": {
"type": "string"
},
"_warning": {
"type": "string"
},
"precedence": {
"type": "integer"
}
}
},
"description": "Style Profile Rules"
},
"active_draft_id": {
"type": "integer",
"format": "int32",
"description": "Active Draft Id"
},
"_kbduplicate01_ok": {
"type": "boolean",
"description": "Kbduplicate01 Ok"
},
"ai_generated_summary": {
"type": "string",
"description": "Ai Generated Summary"
},
"ai_summary": {
"type": "string",
"description": "Ai Summary"
},
"_isclone": {
"type": "boolean",
"description": "The isclone value"
},
"is_an_owner": {
"type": "boolean",
"description": "Is An Owner"
},
"doc_needs_processing": {
"type": "boolean",
"description": "Doc Needs Processing"
},
"doc_processed": {
"type": "boolean",
"description": "Doc Processed"
},
"feedback_tickettype_anon": {
"type": "boolean",
"description": "Feedback Tickettype Anon"
},
"access_control_level": {
"type": "integer",
"format": "int32",
"description": "Access Control Level"
},
"use": {
"type": "string",
"description": "The use value"
},
"key": {
"type": "integer",
"format": "int32",
"description": "The key value"
},
"table": {
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
980,
986,
987,
988,
989,
990,
991,
992,
993,
995,
996,
997,
998,
999,
1001,
1002,
1003,
1005,
1006,
1007,
1008,
1009,
1010,
1011,
1012,
1013,
1014,
1015,
1016,
1017,
1018,
1019,
1020,
1021,
1022,
1023,
1024,
1025,
1026,
1027,
1029,
1030,
1031,
1035,
-1
],
"description": "The table value"
},
"ticket_template_id": {
"type": "integer",
"format": "int32",
"description": "Ticket Template Id"
},
"faqdseq": {
"type": "integer",
"format": "int32",
"description": "The faqdseq value"
},
"faqliststr": {
"type": "string",
"description": "The faqliststr value"
},
"faqlists": {
"type": "array",
"items": {
"type": "object",
"properties": {
"guid": {
"type": "string"
},
"intent": {
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"showforall": {
"type": "boolean"
},
"showforallagents": {
"type": "boolean"
},
"level": {
"type": "integer"
},
"description": {
"type": "string"
},
"is_group": {
"type": "boolean"
},
"group_id": {
"type": "integer"
},
"group_name": {
"type": "string"
},
"full_name": {
"type": "string"
},
"sequence": {
"type": "integer"
},
"article_count": {
"type": "integer"
},
"type": {
"type": "integer"
},
"grandparent_name": {
"type": "string"
},
"greatgrandparent_name": {
"type": "string"
},
"greatgreatgrandparent_name": {
"type": "string"
},
"greatgreatgreatgrandparent_name": {
"type": "string"
},
"fullgroup_name": {
"type": "string"
},
"new_external_link": {
"type": "object"
},
"_match_thirdparty_id": {
"type": "string"
},
"_match_additional_id": {
"type": "string"
},
"_match_integration_id": {
"type": "integer"
},
"_match_integration_name": {
"type": "string"
},
"_isimport": {
"type": "boolean"
},
"_importtype": {
"type": "string"
},
"import_details_id": {
"type": "integer"
},
"third_party_id": {
"type": "string"
},
"translations": {
"type": "array"
},
"access_control": {
"type": "array"
},
"access_control_level": {
"type": "integer"
},
"dontshowonportal": {
"type": "boolean"
},
"allow_indexing": {
"type": "boolean"
},
"geo_restrictions": {
"type": "array"
},
"linked_articles": {
"type": "array"
},
"style_profile_links": {
"type": "array"
},
"showtoallwithperms": {
"type": "boolean"
},
"show_to_all_suppliers": {
"type": "boolean"
}
}
},
"description": "The faqlists value"
},
"description_list": {
"type": "string",
"description": "Description List"
},
"key_copy": {
"type": "string",
"format": "uuid",
"description": "Key Copy"
},
"all_version_view_count": {
"type": "integer",
"format": "int32",
"description": "All Version View Count"
},
"search_count": {
"type": "integer",
"format": "int32",
"description": "Search Count"
},
"_importtypeid": {
"type": "integer",
"format": "int32",
"description": "The importtypeid value"
},
"_importthirdpartyid": {
"type": "string",
"description": "The importthirdpartyid value"
},
"_importtype": {
"type": "string",
"description": "The importtype value"
},
"import_details_id": {
"type": "integer",
"format": "int32",
"description": "Import Details Id"
},
"_isupdateimport": {
"type": "boolean",
"description": "The isupdateimport value"
},
"_match_integration_button_caption": {
"type": "string",
"description": "Match Integration Button Caption"
},
"_match_integration_button_url": {
"type": "string",
"description": "Match Integration Button Url"
},
"_match_integration_button_icon": {
"type": "string",
"description": "Match Integration Button Icon"
}
}
},
"description": "Request body"
}
},
"required": [
"PCID"
]
}
```