haloapi-mcp-tools

{ "openapi": "3.0.1", "info": { "title": "Halo API", "description": "The HaloITSM, HaloPSA and HaloServiceDesk REST API", "version": "v2" }, "servers": [ { "url": "/api" } ], "paths": { "/Actions": { "get": { "tags": [ "Actions" ], "summary": "List of Actions", "description": "Use this to return multiple Actions. \r\n\t\t\t\tRequires authentication.", "parameters": [ { "name": "actoutcome", "in": "query", "description": "(string) Filter on the name of the action.", "schema": { "type": "string" } }, { "name": "actoutcomenum", "in": "query", "description": "(int) Filter on the system field ID.", "schema": { "type": "int" } }, { "name": "agentonly", "in": "query", "description": "(bool) Only get actions done by Agents.", "schema": { "type": "bool" } }, { "name": "conversationonly", "in": "query", "description": "(bool) Only get actions relating to the Agent to End User conversation.", "schema": { "type": "bool" } }, { "name": "count", "in": "query", "description": "(int) Number of actions to return in the response.", "schema": { "type": "int" } }, { "name": "datesearch", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "enddate", "in": "query", "description": "(string) Specifies the search parameter in which actions will have occured before this date.", "schema": { "type": "string" } }, { "name": "excludebilling", "in": "query", "description": "(bool) Excludes any actions associated with billing (e.g. Send Invoice by Email).", "schema": { "type": "bool" } }, { "name": "excludehiddenfrominternalit", "in": "query", "description": "(bool) Excludes any action marked at action level to be hidden from Agents with Client Group set.", "schema": { "type": "bool" } }, { "name": "excludeprivate", "in": "query", "description": "(bool) Only get public actions.", "schema": { "type": "bool" } }, { "name": "excludesys", "in": "query", "description": "(bool) Exclude system actions.", "schema": { "type": "bool" } }, { "name": "importantonly", "in": "query", "description": "(bool) Only get important actions.", "schema": { "type": "bool" } }, { "name": "importanttop", "in": "query", "description": "(bool) Orders the response by important actions first.", "schema": { "type": "bool" } }, { "name": "includeagentdetails", "in": "query", "description": "(bool) Include agent details in the response.", "schema": { "type": "bool" } }, { "name": "includeattachments", "in": "query", "description": "(bool) Include attachment details in the response.", "schema": { "type": "bool" } }, { "name": "includefacebookfields", "in": "query", "description": "", "schema": { "type": "bool" } }, { "name": "includehtmlemail", "in": "query", "description": "(bool) Include the action email HTML as part of the response.", "schema": { "type": "bool" } }, { "name": "includehtmlnote", "in": "query", "description": "(bool) Include the action note HTML as part of the response.", "schema": { "type": "bool" } }, { "name": "includenonactionattachments", "in": "query", "description": "", "schema": { "type": "bool" } }, { "name": "includetranslations", "in": "query", "description": "(bool) Includes the translation count in the response.", "schema": { "type": "bool" } }, { "name": "includetwitterfields", "in": "query", "description": "(bool) Include Twitter fields in the response.", "schema": { "type": "bool" } }, { "name": "intraticketonly", "in": "query", "description": "(bool) Get actions that are part of the .", "schema": { "type": "bool" } }, { "name": "ischildnotes", "in": "query", "description": "(bool) Only get actions from child tickets.", "schema": { "type": "bool" } }, { "name": "isrelatednotes", "in": "query", "description": "(bool) Only get actions from related tickets.", "schema": { "type": "bool" } }, { "name": "slaonly", "in": "query", "description": "(bool) Only get SLA hold and release actions.", "schema": { "type": "bool" } }, { "name": "startdate", "in": "query", "description": "(string) Specifies the search parameter in which actions will have occured after this date.", "schema": { "type": "string" } }, { "name": "supplieronly", "in": "query", "description": "(bool) Only get actions relating to Suppliers.", "schema": { "type": "bool" } }, { "name": "ticket_id", "in": "query", "description": "(int) The ID of the Ticket to get actions for.", "schema": { "type": "int" } }, { "name": "timeentriesonly", "in": "query", "description": "", "schema": { "type": "bool" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Actions" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Actions" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Actions" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Actions" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Actions" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/Actions/{id}": { "get": { "tags": [ "Actions" ], "summary": "Get one Actions", "description": "Use this to return a single instance of Actions. \r\n\t\t\t\tRequires authentication.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "agentonly", "in": "query", "description": "(bool) Only get actions done by Agents.", "schema": { "type": "bool" } }, { "name": "emailonly", "in": "query", "description": "(bool) Only get email actions.", "schema": { "type": "bool" } }, { "name": "includedetails", "in": "query", "description": "(bool) Include extra objects in the response.", "schema": { "type": "bool" } }, { "name": "includeemail", "in": "query", "description": "(bool) Include the plain text and HTML email body in the response.", "schema": { "type": "bool" } }, { "name": "mostrecent", "in": "query", "description": "(bool) Get the most recent action on the ticket.", "schema": { "type": "bool" } }, { "name": "nonsystem", "in": "query", "description": "(bool) Only get non system actions.", "schema": { "type": "bool" } }, { "name": "penultimate", "in": "query", "description": "(bool) Only get actions that are not the most recent.", "schema": { "type": "bool" } }, { "name": "ticket_id", "in": "query", "description": "(int) The ID of the Ticket to get the action for.", "schema": { "type": "int" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Actions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/Actions/reaction": { "post": { "tags": [ "Actions" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ActionReaction" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ActionReaction" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActionReaction" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ActionReaction" } } } }, "responses": { "200": { "description": "OK" } } } }, "/Actions/Review": { "post": { "tags": [ "Actions" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Actions" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Actions" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Actions" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Actions" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/Addressbook": { "get": { "tags": [ "addressbook" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "addressbook" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Addressbook" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Addressbook" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Addressbook" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Addressbook" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/Addressbook/{id}": { "get": { "tags": [ "addressbook" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "addressbook" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/Address": { "get": { "tags": [ "AddressStore" ], "summary": "List of AddressStore", "description": "Use this to return multiple AddressStore. \r\n\t\t\t\tRequires authentication.", "parameters": [ { "name": "count", "in": "query", "description": "", "schema": { "type": "int" } }, { "name": "postcode", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "site_id", "in": "query", "description": "", "schema": { "type": "int" } }, { "name": "type_id", "in": "query", "description": "", "schema": { "type": "int" } }, { "name": "user_id", "in": "query", "description": "", "schema": { "type": "int" } }, { "name": "openedafter", "in": "query", "description": "(bool) Only return tickets opened within the last 30 days." }, { "name": "onholdonly", "in": "query", "description": "(bool) Only return tickets that are on SLA hold." }, { "name": "overrideclientid", "in": "query", "description": "(int) Filter tickets to a client id." }, { "name": "overridesiteid", "in": "query", "description": "(int) Filter tickets to a site id." }, { "name": "overrideuserid", "in": "query", "description": "(int) Filter tickets to a user id." } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "AddressStore" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddressStore" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddressStore" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddressStore" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddressStore" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/Address/{id}": { "get": { "tags": [ "AddressStore" ], "summary": "Get one AddressStore", "description": "Use this to return a single instance of AddressStore. \r\n\t\t\t\tRequires authentication.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "includedetails", "in": "query", "description": "", "schema": { "type": "bool" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "AddressStore" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/AdobeAcrobatDetails": { "get": { "tags": [ "AdobeAcrobatDetails" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "AdobeAcrobatDetails" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdobeAcrobatDetails" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdobeAcrobatDetails" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdobeAcrobatDetails" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdobeAcrobatDetails" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/AdobeAcrobatDetails/{id}": { "get": { "tags": [ "AdobeAcrobatDetails" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "AdobeAcrobatDetails" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/AdobeCommerceDetails": { "get": { "tags": [ "AdobeCommerceDetails" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "AdobeCommerceDetails" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdobeCommerceDetails" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdobeCommerceDetails" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdobeCommerceDetails" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdobeCommerceDetails" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/AdobeCommerceDetails/{id}": { "get": { "tags": [ "AdobeCommerceDetails" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "AdobeCommerceDetails" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/AdobeCommerceIntegration": { "get": { "tags": [ "AdobeCommerceIntegration" ], "responses": { "200": { "description": "OK" } } } }, "/AdobeCommerceIntegration/auth": { "post": { "tags": [ "AdobeCommerceIntegration" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "obj": { "type": "array", "items": { "$ref": "#/components/schemas/StringStringValuesKeyValuePair" } } } }, "encoding": { "obj": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/AgentCheckIn": { "get": { "tags": [ "AgentCheckIn" ], "summary": "List of AgentCheckIn", "description": "Use this to return multiple AgentCheckIn. \r\n\t\t\t\tRequires authentication.", "parameters": [ { "name": "agent_id", "in": "query", "description": "", "schema": { "type": "int" } }, { "name": "end_date", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "AgentCheckIn" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgentCheckIn" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgentCheckIn" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgentCheckIn" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgentCheckIn" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/AgentCheckIn/{id}": { "get": { "tags": [ "AgentCheckIn" ], "summary": "Get one AgentCheckIn", "description": "Use this to return a single instance of AgentCheckIn. \r\n\t\t\t\tRequires authentication.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "includedetails", "in": "query", "description": "", "schema": { "type": "bool" } } ], "responses": { "200": { "description": "OK" } } } }, "/AgentImage/{id}": { "get": { "tags": [ "AgentImage" ], "summary": "Get one Uname", "description": "Use this to return a single instance of Uname. \r\n\t\t\t\tRequires authentication.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "clientidoverride", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "get_htmldesigner_signature", "in": "query", "description": "", "schema": { "type": "bool" } }, { "name": "getholidayallowance", "in": "query", "description": "", "schema": { "type": "bool" } }, { "name": "includedetails", "in": "query", "description": "(bool) Include extra objects in the response.", "schema": { "type": "bool" } }, { "name": "isagentconfig", "in": "query", "description": "", "schema": { "type": "bool" } }, { "name": "loadcache", "in": "query", "description": "", "schema": { "type": "bool" } } ], "responses": { "200": { "description": "OK" } } } }, "/AISuggestion": { "get": { "tags": [ "AiSuggestion" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "AiSuggestion" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AiSuggestion" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AiSuggestion" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AiSuggestion" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AiSuggestion" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/AISuggestion/{id}": { "get": { "tags": [ "AiSuggestion" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "AiSuggestion" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/AmazonSellerDetails": { "get": { "tags": [ "AmazonSellerDetails" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "AmazonSellerDetails" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AmazonSellerDetails" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AmazonSellerDetails" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AmazonSellerDetails" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AmazonSellerDetails" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/AmazonSellerDetails/{id}": { "get": { "tags": [ "AmazonSellerDetails" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "AmazonSellerDetails" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/Report": { "get": { "tags": [ "AnalyzerProfile" ], "summary": "List of AnalyzerProfile", "description": "Use this to return multiple AnalyzerProfile. \r\n\t\t\t\tRequires authentication.", "parameters": [ { "name": "agentrestriction", "in": "query", "description": "", "schema": { "type": "int" } }, { "name": "chartonly", "in": "query", "description": "", "schema": { "type": "bool" } }, { "name": "clientname", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "count", "in": "query", "description": "", "schema": { "type": "int" } }, { "name": "includepublished", "in": "query", "description": "", "schema": { "type": "bool" } }, { "name": "order", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "order2", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "order3", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "order4", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "order5", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderdesc", "in": "query", "description": "", "schema": { "type": "bool" } }, { "name": "orderdesc2", "in": "query", "description": "", "schema": { "type": "bool" } }, { "name": "orderdesc3", "in": "query", "description": "", "schema": { "type": "bool" } }, { "name": "orderdesc4", "in": "query", "description": "", "schema": { "type": "bool" } }, { "name": "orderdesc5", "in": "query", "description": "", "schema": { "type": "bool" } }, { "name": "page_no", "in": "query", "description": "", "schema": { "type": "int" } }, { "name": "page_size", "in": "query", "description": "", "schema": { "type": "int" } }, { "name": "pageinate", "in": "query", "description": "", "schema": { "type": "bool" } }, { "name": "reportgroup_id", "in": "query", "description": "", "schema": { "type": "int" } }, { "name": "search", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "", "schema": { "type": "int" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "AnalyzerProfile" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AnalyzerProfile" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AnalyzerProfile" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AnalyzerProfile" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AnalyzerProfile" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/Report/{id}": { "get": { "tags": [ "AnalyzerProfile" ], "summary": "Get one AnalyzerProfile", "description": "Use this to return a single instance of AnalyzerProfile. \r\n\t\t\t\tRequires authentication.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "client_id", "in": "query", "description": "", "schema": { "type": "int" } }, { "name": "clientname", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "dashboard_id", "in": "query", "description": "", "schema": { "type": "int" } }, { "name": "dashboard_published_id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "dontloadsystemreport", "in": "query", "description": "", "schema": { "type": "bool" } }, { "name": "getcompositetoken", "in": "query", "description": "", "schema": { "type": "bool" } }, { "name": "includedetails", "in": "query", "description": "", "schema": { "type": "bool" } }, { "name": "invoice_id", "in": "query", "description": "", "schema": { "type": "int" } }, { "name": "loadreport", "in": "query", "description": "", "schema": { "type": "bool" } }, { "name": "report_access_token", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "reportingperiod", "in": "query", "description": "", "schema": { "type": "int" } }, { "name": "reportingperiodenddate", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "reportingperiodstartdate", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "AnalyzerProfile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/Report/print": { "post": { "tags": [ "AnalyzerProfile" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AnalyzerProfile" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AnalyzerProfile" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AnalyzerProfile" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AnalyzerProfile" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/Report/createpdf": { "post": { "tags": [ "AnalyzerProfile" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AnalyzerProfile" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AnalyzerProfile" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AnalyzerProfile" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AnalyzerProfile" } } } }, "responses": { "200": { "description": "OK" } } } }, "/Report/Bookmark": { "post": { "tags": [ "AnalyzerProfile" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AnalyzerProfile" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AnalyzerProfile" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AnalyzerProfile" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AnalyzerProfile" } } } }, "responses": { "200": { "description": "OK" } } } }, "/Appointment": { "get": { "tags": [ "Appointment" ], "summary": "List of Appointment", "description": "Use this to return multiple Appointment. \r\n\t\t\t\tRequires authentication.", "parameters": [ { "name": "advanced_search", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "agents", "in": "query", "description": "(string) Comma separated list of agent IDs. Returns these agent's appointments.", "schema": { "type": "string" } }, { "name": "appointmentsonly", "in": "query", "description": "(bool) Only return appointments in the response.", "schema": { "type": "bool" } }, { "name": "assets", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "(int) Return appointments assigned to a particular client.", "schema": { "type": "int" } }, { "name": "end_date", "in": "query", "description": "(string) Return appointments with an end date greater than this value.", "schema": { "type": "string" } }, { "name": "excludenonticketapptodo", "in": "query", "description": "", "schema": { "type": "bool" } }, { "name": "excluderecurring", "in": "query", "description": "(bool) Exclude recurring appointments in the response.", "schema": { "type": "bool" } }, { "name": "excluderecurringmaster", "in": "query", "description": "(bool) Exclude recurring master appointments in the response.", "schema": { "type": "bool" } }, { "name": "getopenjourney", "in": "query", "description": "", "schema": { "type": "bool" } }, { "name": "hidecompleted", "in": "query", "description": "(bool) Exclude completed appointments from the response.", "schema": { "type": "bool" } }, { "name": "includedeleted", "in": "query", "description": "(bool) Include deleted appointments in the response.