ManageEngine ServiceDesk Plus

Use cases and templates: ManageEngine ServiceDesk Plus integration for AI agents

Use ManageEngine ServiceDesk Plus Cloud to manage requests, problems, changes, assets, and knowledge-base solutions through its v3 REST API. The 31 operations cover create, read, list, update, and delete across those modules, plus request, problem, and change notes.

Lookup fields such as status, priority, category, technician, group, topic, and product use names or email addresses. Custom fields use the udf_* keys. Use search_criteria for server-side filtering with text, numeric, and date comparisons; for example, sort requests by due_by_time to find approaching deadlines. Solutions and requester-visible notes can support ticket replies; resolved requests and notes can supply a new knowledge-base article.

Before you start

Connect your Zoho account from the block's credential field. Self-hosted deployments additionally need Sim's Zoho OAuth client configured in the Zoho API console. The same client serves Zoho Desk and ServiceDesk Plus — Zoho scopes are chosen per authorization request, not per registered client, so no second app is needed.

Three things shape what will work:

  • Data center. Connecting requires a Zoho account in the US data center. Sim's authorize and token-exchange legs are pinned to accounts.zoho.com, and a Zoho access token is only valid in the data center that issued it. The Data Center field lists every documented host (US, EU, IN, AU, JP, CA, SA, UK, CN, AE) because that mapping is stable, but only US is reachable with a credential connected through Sim today.
  • Portal. Accounts with more than one portal must set the Portal field to the portal's URL name — found under ESM Directory → Service Desk Instances. Leaving it empty addresses the account's default portal.
  • Scopes. The connection requests SDPOnDemand.{requests,problems,changes,assets,solutions} at the exact verbs these operations use, plus aaaserver.profile.READ to label the credential. Nothing broader is requested, so an operation whose module your Zoho user cannot access will fail at ServiceDesk Plus rather than being silently skipped.

Updates and pagination

  • Required fields differ per module. Requests need a subject; problems a title; changes a title, stage, and status; assets a name and an existing product; solutions a title, content, and an existing topic.
  • Editing a change's status requires a comment. ServiceDesk Plus rejects the update otherwise, so the Status Comment field sits alongside the status on Update Change.
  • Updates only send what you fill in. Fields left empty are omitted from the request rather than sent as null, so changing a status never clears the technician or category. The two flags that cannot express this with a toggle — Emergency Change and Visible to Requesters — become Leave unchanged / Yes / No dropdowns on their update operations for the same reason.
  • A solution only becomes requester-visible once approved. ServiceDesk Plus ignores is_public until the article's approval status is Approved.
  • Lists cap at 100 rows. Row Count is clamped to the documented maximum; page with Start Index and watch has_more_rows in the returned listInfo. Set Include Total Count when you need the true size of a queue rather than the page size.
  • The standalone Tasks module is not covered. Its endpoints are documented but the ServiceDesk Plus scope table publishes no tasks entry, so requesting one would put an unverified scope on the consent screen.

OAuth scopes

Sim requests these scopes when someone connects a ManageEngine ServiceDesk Plus account. For a self-hosted deployment, register your own app with the provider using the settings below. See Integrations and OAuth for setup.

SettingValue
Redirect URI<NEXT_PUBLIC_APP_URL>/api/auth/oauth2/callback/manageengine-sdp
Environment variablesZOHO_CLIENT_ID, ZOHO_CLIENT_SECRET
ScopeDescription
SDPOnDemand.requests.CREATECreate requests
SDPOnDemand.requests.READView requests and their notes
SDPOnDemand.requests.UPDATEUpdate requests and add notes
SDPOnDemand.requests.DELETEDelete requests
SDPOnDemand.problems.CREATECreate problems
SDPOnDemand.problems.READView problems and their notes
SDPOnDemand.problems.UPDATEUpdate problems and add notes
SDPOnDemand.problems.DELETEDelete problems
SDPOnDemand.changes.CREATECreate changes
SDPOnDemand.changes.READView changes and their notes
SDPOnDemand.changes.UPDATEUpdate changes and add notes
SDPOnDemand.changes.DELETEDelete changes
SDPOnDemand.assets.CREATECreate assets
SDPOnDemand.assets.READView assets
SDPOnDemand.assets.UPDATEUpdate assets
SDPOnDemand.assets.DELETEDelete assets
SDPOnDemand.solutions.CREATECreate knowledge base solutions
SDPOnDemand.solutions.READView knowledge base solutions
SDPOnDemand.solutions.UPDATEUpdate knowledge base solutions
SDPOnDemand.solutions.DELETEDelete knowledge base solutions
aaaserver.profile.READView your Zoho profile

Use the block

Full read and write access to ManageEngine ServiceDesk Plus Cloud: create, search, update and delete requests, problems, changes, assets and knowledge base solutions, and add notes to requests, problems and changes. Supports multi-portal accounts. Connecting requires a Zoho account in the US data center.

Actions

ManageEngine SDP Create Request

Create a request (ticket) in ManageEngine ServiceDesk Plus Cloud with a subject, description, requester and classification.

Input

ParameterTypeRequiredDescription
dataCenterstringNoZoho data center hosting the portal (US, EU, IN, AU, JP, CA, SA, UK, CN, AE). Credentials connected through Sim are issued by the US accounts server and are only valid against US.
portalstringNoPortal URL name. Leave empty to use the account default portal
subjectstringYesRequest subject (maximum 250 characters)
descriptionstringNoRequest description. HTML is supported
requesterEmailstringNoEmail address of the requester. Defaults to the authenticated user
prioritystringNoPriority name, e.g. High
statusstringNoStatus name, e.g. Open
categorystringNoCategory name
subcategorystringNoSubcategory name
groupstringNoSupport group name
technicianEmailstringNoEmail address of the technician to assign
urgencystringNoUrgency name
impactstringNoImpact name
requestTypestringNoRequest type name, e.g. Incident or Service Request
udfFieldsjsonNoPortal-defined custom fields, e.g. {"udf_char1":"value"}

Output

ParameterTypeDescription
requestobjectThe created request
↳ idstringRequest ID
↳ display_idstringRequest number shown in the SDP UI
↳ subjectstringRequest subject
↳ descriptionstringRequest description (HTML)
↳ statusjsonCurrent status
↳ idstringIdentifier
↳ namestringDisplay name
↳ colorstringStatus colour
↳ in_progressbooleanWhether the status is in progress
↳ internal_namestringInternal status name
↳ stop_timerbooleanWhether the SLA timer stops
↳ priorityjsonPriority
↳ idstringIdentifier
↳ namestringDisplay name
↳ colorstringPriority colour
↳ requesterjsonRequester
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ technicianjsonAssigned technician
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ groupjsonSupport group
↳ idstringIdentifier
↳ namestringDisplay name
↳ sitestringSite the group belongs to
↳ deletedbooleanWhether the group is deleted
↳ categoryjsonCategory
↳ idstringIdentifier
↳ namestringDisplay name
↳ subcategoryjsonSubcategory
↳ idstringIdentifier
↳ namestringDisplay name
↳ urgencyjsonUrgency
↳ idstringIdentifier
↳ namestringDisplay name
↳ impactjsonImpact
↳ idstringIdentifier
↳ namestringDisplay name
↳ templatejsonRequest template
↳ idstringIdentifier
↳ namestringDisplay name
↳ sitejsonSite
↳ idstringIdentifier
↳ namestringDisplay name
↳ created_timejsonCreation time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ due_by_timejsonSLA due time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ resolved_timejsonResolution time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ completed_timejsonCompletion time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ is_service_requestbooleanWhether this is a service request rather than an incident
↳ has_notesbooleanWhether the request has notes
↳ udf_fieldsjsonPortal-defined custom fields

ManageEngine SDP Get Request

Retrieve a single ManageEngine ServiceDesk Plus Cloud request by ID.

Input

ParameterTypeRequiredDescription
dataCenterstringNoZoho data center hosting the portal (US, EU, IN, AU, JP, CA, SA, UK, CN, AE). Credentials connected through Sim are issued by the US accounts server and are only valid against US.
portalstringNoPortal URL name. Leave empty to use the account default portal
requestIdstringYesID of the request to retrieve

Output

ParameterTypeDescription
requestobjectThe request
↳ idstringRequest ID
↳ display_idstringRequest number shown in the SDP UI
↳ subjectstringRequest subject
↳ descriptionstringRequest description (HTML)
↳ statusjsonCurrent status
↳ idstringIdentifier
↳ namestringDisplay name
↳ colorstringStatus colour
↳ in_progressbooleanWhether the status is in progress
↳ internal_namestringInternal status name
↳ stop_timerbooleanWhether the SLA timer stops
↳ priorityjsonPriority
↳ idstringIdentifier
↳ namestringDisplay name
↳ colorstringPriority colour
↳ requesterjsonRequester
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ technicianjsonAssigned technician
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ groupjsonSupport group
↳ idstringIdentifier
↳ namestringDisplay name
↳ sitestringSite the group belongs to
↳ deletedbooleanWhether the group is deleted
↳ categoryjsonCategory
↳ idstringIdentifier
↳ namestringDisplay name
↳ subcategoryjsonSubcategory
↳ idstringIdentifier
↳ namestringDisplay name
↳ urgencyjsonUrgency
↳ idstringIdentifier
↳ namestringDisplay name
↳ impactjsonImpact
↳ idstringIdentifier
↳ namestringDisplay name
↳ templatejsonRequest template
↳ idstringIdentifier
↳ namestringDisplay name
↳ sitejsonSite
↳ idstringIdentifier
↳ namestringDisplay name
↳ created_timejsonCreation time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ due_by_timejsonSLA due time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ resolved_timejsonResolution time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ completed_timejsonCompletion time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ is_service_requestbooleanWhether this is a service request rather than an incident
↳ has_notesbooleanWhether the request has notes
↳ udf_fieldsjsonPortal-defined custom fields

ManageEngine SDP List Requests

List ManageEngine ServiceDesk Plus Cloud requests, with optional search criteria, sorting and paging.

Input

ParameterTypeRequiredDescription
dataCenterstringNoZoho data center hosting the portal (US, EU, IN, AU, JP, CA, SA, UK, CN, AE). Credentials connected through Sim are issued by the US accounts server and are only valid against US.
portalstringNoPortal URL name. Leave empty to use the account default portal
rowCountnumberNoRows to return (maximum 100)
startIndexnumberNoOne-based index of the first row to return
sortFieldstringNoField to sort on, e.g. created_time
sortOrderstringNoSort direction: asc or desc
searchCriteriajsonNoSearch criteria object or array, e.g. {"field":"status.name","condition":"is","value":"Open"}
fieldsRequiredjsonNoArray of field names to return, e.g. ["subject","status"]
getTotalCountbooleanNoInclude the total matching row count in list_info

Output

ParameterTypeDescription
requestsarrayMatching requests
↳ idstringRequest ID
↳ display_idstringRequest number shown in the SDP UI
↳ subjectstringRequest subject
↳ descriptionstringRequest description (HTML)
↳ statusjsonCurrent status
↳ idstringIdentifier
↳ namestringDisplay name
↳ colorstringStatus colour
↳ in_progressbooleanWhether the status is in progress
↳ internal_namestringInternal status name
↳ stop_timerbooleanWhether the SLA timer stops
↳ priorityjsonPriority
↳ idstringIdentifier
↳ namestringDisplay name
↳ colorstringPriority colour
↳ requesterjsonRequester
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ technicianjsonAssigned technician
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ groupjsonSupport group
↳ idstringIdentifier
↳ namestringDisplay name
↳ sitestringSite the group belongs to
↳ deletedbooleanWhether the group is deleted
↳ categoryjsonCategory
↳ idstringIdentifier
↳ namestringDisplay name
↳ subcategoryjsonSubcategory
↳ idstringIdentifier
↳ namestringDisplay name
↳ urgencyjsonUrgency
↳ idstringIdentifier
↳ namestringDisplay name
↳ impactjsonImpact
↳ idstringIdentifier
↳ namestringDisplay name
↳ templatejsonRequest template
↳ idstringIdentifier
↳ namestringDisplay name
↳ sitejsonSite
↳ idstringIdentifier
↳ namestringDisplay name
↳ created_timejsonCreation time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ due_by_timejsonSLA due time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ resolved_timejsonResolution time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ completed_timejsonCompletion time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ is_service_requestbooleanWhether this is a service request rather than an incident
↳ has_notesbooleanWhether the request has notes
↳ udf_fieldsjsonPortal-defined custom fields
countnumberNumber of requests returned in this page
listInfoobjectPaging metadata echoed by ServiceDesk Plus
↳ row_countnumberRows returned
↳ start_indexnumberIndex the page started at
↳ pagenumberPage number
↳ has_more_rowsbooleanWhether more rows are available after this page
↳ sort_fieldstringField the results were sorted on
↳ sort_orderstringSort direction
↳ total_countnumberTotal matching rows, present only when get_total_count was requested

ManageEngine SDP Update Request

Update a ManageEngine ServiceDesk Plus Cloud request: change its status, priority, assignment, classification or description.

Input

ParameterTypeRequiredDescription
dataCenterstringNoZoho data center hosting the portal (US, EU, IN, AU, JP, CA, SA, UK, CN, AE). Credentials connected through Sim are issued by the US accounts server and are only valid against US.
portalstringNoPortal URL name. Leave empty to use the account default portal
requestIdstringYesID of the request to update
subjectstringNoNew subject (maximum 250 characters)
descriptionstringNoNew description. HTML is supported
prioritystringNoPriority name to set, e.g. High
statusstringNoStatus name to set, e.g. Resolved
categorystringNoCategory name to set
subcategorystringNoSubcategory name to set
groupstringNoSupport group name to set
technicianEmailstringNoEmail address of the technician to assign
urgencystringNoUrgency name to set
impactstringNoImpact name to set
udfFieldsjsonNoPortal-defined custom fields to set, e.g. {"udf_char1":"value"}

Output

ParameterTypeDescription
requestobjectThe updated request
↳ idstringRequest ID
↳ display_idstringRequest number shown in the SDP UI
↳ subjectstringRequest subject
↳ descriptionstringRequest description (HTML)
↳ statusjsonCurrent status
↳ idstringIdentifier
↳ namestringDisplay name
↳ colorstringStatus colour
↳ in_progressbooleanWhether the status is in progress
↳ internal_namestringInternal status name
↳ stop_timerbooleanWhether the SLA timer stops
↳ priorityjsonPriority
↳ idstringIdentifier
↳ namestringDisplay name
↳ colorstringPriority colour
↳ requesterjsonRequester
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ technicianjsonAssigned technician
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ groupjsonSupport group
↳ idstringIdentifier
↳ namestringDisplay name
↳ sitestringSite the group belongs to
↳ deletedbooleanWhether the group is deleted
↳ categoryjsonCategory
↳ idstringIdentifier
↳ namestringDisplay name
↳ subcategoryjsonSubcategory
↳ idstringIdentifier
↳ namestringDisplay name
↳ urgencyjsonUrgency
↳ idstringIdentifier
↳ namestringDisplay name
↳ impactjsonImpact
↳ idstringIdentifier
↳ namestringDisplay name
↳ templatejsonRequest template
↳ idstringIdentifier
↳ namestringDisplay name
↳ sitejsonSite
↳ idstringIdentifier
↳ namestringDisplay name
↳ created_timejsonCreation time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ due_by_timejsonSLA due time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ resolved_timejsonResolution time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ completed_timejsonCompletion time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ is_service_requestbooleanWhether this is a service request rather than an incident
↳ has_notesbooleanWhether the request has notes
↳ udf_fieldsjsonPortal-defined custom fields

ManageEngine SDP Delete Request

Move a ManageEngine ServiceDesk Plus Cloud request to the trash. Deleting a request also removes its notes, tasks and worklogs.

Input

ParameterTypeRequiredDescription
dataCenterstringNoZoho data center hosting the portal (US, EU, IN, AU, JP, CA, SA, UK, CN, AE). Credentials connected through Sim are issued by the US accounts server and are only valid against US.
portalstringNoPortal URL name. Leave empty to use the account default portal
requestIdstringYesID of the request to delete

Output

ParameterTypeDescription
deletedbooleanWhether the request was deleted

ManageEngine SDP Add Request Note

Add a note to a ManageEngine ServiceDesk Plus Cloud request, optionally making it visible to the requester.

Input

ParameterTypeRequiredDescription
dataCenterstringNoZoho data center hosting the portal (US, EU, IN, AU, JP, CA, SA, UK, CN, AE). Credentials connected through Sim are issued by the US accounts server and are only valid against US.
portalstringNoPortal URL name. Leave empty to use the account default portal
requestIdstringYesID of the request to add the note to
descriptionstringYesNote body. HTML is supported
showToRequesterbooleanNoWhether the requester can see this note
notifyTechnicianbooleanNoWhether to notify the assigned technician
markFirstResponsebooleanNoWhether this note counts as the first response for SLA purposes
addToLinkedRequestsbooleanNoWhether to copy the note to linked requests

Output

ParameterTypeDescription
noteobjectThe created note
↳ idstringNote ID
↳ descriptionstringNote body (HTML)
↳ show_to_requesterbooleanWhether the note is visible to the requester
↳ notify_technicianbooleanWhether the technician was notified
↳ mark_first_responsebooleanWhether the note counts as the first response
↳ add_to_linked_requestsbooleanWhether the note was copied to linked requests
↳ created_timejsonCreation time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ created_byjsonNote author
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ requestjsonThe request the note belongs to
↳ idstringRequest ID
↳ display_idstringRequest number
↳ subjectstringRequest subject

ManageEngine SDP List Request Notes

List the notes on a ManageEngine ServiceDesk Plus Cloud request.

Input

ParameterTypeRequiredDescription
dataCenterstringNoZoho data center hosting the portal (US, EU, IN, AU, JP, CA, SA, UK, CN, AE). Credentials connected through Sim are issued by the US accounts server and are only valid against US.
portalstringNoPortal URL name. Leave empty to use the account default portal
requestIdstringYesID of the request whose notes to list
rowCountnumberNoRows to return (maximum 100)
startIndexnumberNoOne-based index of the first row to return
sortFieldstringNoField to sort on, e.g. created_time
sortOrderstringNoSort direction: asc or desc
searchCriteriajsonNoSearch criteria object or array, e.g. {"field":"status.name","condition":"is","value":"Open"}
fieldsRequiredjsonNoArray of field names to return, e.g. ["subject","status"]
getTotalCountbooleanNoInclude the total matching row count in list_info

Output

ParameterTypeDescription
notesarrayNotes on the request
↳ idstringNote ID
↳ descriptionstringNote body (HTML)
↳ show_to_requesterbooleanWhether the note is visible to the requester
↳ notify_technicianbooleanWhether the technician was notified
↳ mark_first_responsebooleanWhether the note counts as the first response
↳ add_to_linked_requestsbooleanWhether the note was copied to linked requests
↳ created_timejsonCreation time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ created_byjsonNote author
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ requestjsonThe request the note belongs to
↳ idstringRequest ID
↳ display_idstringRequest number
↳ subjectstringRequest subject
countnumberNumber of notes returned in this page
listInfoobjectPaging metadata echoed by ServiceDesk Plus
↳ row_countnumberRows returned
↳ start_indexnumberIndex the page started at
↳ pagenumberPage number
↳ has_more_rowsbooleanWhether more rows are available after this page
↳ sort_fieldstringField the results were sorted on
↳ sort_orderstringSort direction
↳ total_countnumberTotal matching rows, present only when get_total_count was requested

ManageEngine SDP Create Problem

Create a problem record in ManageEngine ServiceDesk Plus Cloud with a title, description and classification.

Input

ParameterTypeRequiredDescription
dataCenterstringNoZoho data center hosting the portal (US, EU, IN, AU, JP, CA, SA, UK, CN, AE). Credentials connected through Sim are issued by the US accounts server and are only valid against US.
portalstringNoPortal URL name. Leave empty to use the account default portal
titlestringYesProblem title
descriptionstringNoProblem description. HTML is supported
reportedByEmailstringNoEmail address of the user reporting the problem
technicianEmailstringNoEmail address of the technician to assign
prioritystringNoPriority name, e.g. High
statusstringNoStatus name, e.g. Open
urgencystringNoUrgency name
impactstringNoImpact name
categorystringNoCategory name
subcategorystringNoSubcategory name
groupstringNoSupport group name
sitestringNoSite name
udfFieldsjsonNoPortal-defined custom fields, e.g. {"udf_char1":"value"}

Output

ParameterTypeDescription
problemobjectThe created problem
↳ idstringProblem ID
↳ display_idjsonProblem number shown in the SDP UI (display_value, value)
↳ display_valuestringRecord number as shown in the UI, e.g. PB-140
↳ valuestringBare sequence number, e.g. 140
↳ titlestringProblem title
↳ descriptionstringProblem description (HTML)
↳ statusjsonCurrent status
↳ idstringIdentifier
↳ namestringDisplay name
↳ priorityjsonPriority
↳ idstringIdentifier
↳ namestringDisplay name
↳ urgencyjsonUrgency
↳ idstringIdentifier
↳ namestringDisplay name
↳ impactjsonImpact
↳ idstringIdentifier
↳ namestringDisplay name
↳ categoryjsonCategory
↳ idstringIdentifier
↳ namestringDisplay name
↳ subcategoryjsonSubcategory
↳ idstringIdentifier
↳ namestringDisplay name
↳ groupjsonSupport group
↳ idstringIdentifier
↳ namestringDisplay name
↳ sitejsonSite
↳ idstringIdentifier
↳ namestringDisplay name
↳ reported_byjsonUser who reported the problem
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ technicianjsonAssigned technician
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ reported_timejsonTime the problem was reported
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ due_by_timejsonDue time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ closed_timejsonTime the problem was closed
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ root_causejsonRoot cause analysis
↳ workaround_detailsjsonDocumented workaround
↳ resolution_detailsjsonDocumented resolution
↳ known_error_detailsjsonKnown-error record details
↳ notes_presentbooleanWhether the problem has notes

ManageEngine SDP Get Problem

Retrieve a single ManageEngine ServiceDesk Plus Cloud problem by ID.

Input

ParameterTypeRequiredDescription
dataCenterstringNoZoho data center hosting the portal (US, EU, IN, AU, JP, CA, SA, UK, CN, AE). Credentials connected through Sim are issued by the US accounts server and are only valid against US.
portalstringNoPortal URL name. Leave empty to use the account default portal
problemIdstringYesID of the problem to retrieve

Output

ParameterTypeDescription
problemobjectThe problem
↳ idstringProblem ID
↳ display_idjsonProblem number shown in the SDP UI (display_value, value)
↳ display_valuestringRecord number as shown in the UI, e.g. PB-140
↳ valuestringBare sequence number, e.g. 140
↳ titlestringProblem title
↳ descriptionstringProblem description (HTML)
↳ statusjsonCurrent status
↳ idstringIdentifier
↳ namestringDisplay name
↳ priorityjsonPriority
↳ idstringIdentifier
↳ namestringDisplay name
↳ urgencyjsonUrgency
↳ idstringIdentifier
↳ namestringDisplay name
↳ impactjsonImpact
↳ idstringIdentifier
↳ namestringDisplay name
↳ categoryjsonCategory
↳ idstringIdentifier
↳ namestringDisplay name
↳ subcategoryjsonSubcategory
↳ idstringIdentifier
↳ namestringDisplay name
↳ groupjsonSupport group
↳ idstringIdentifier
↳ namestringDisplay name
↳ sitejsonSite
↳ idstringIdentifier
↳ namestringDisplay name
↳ reported_byjsonUser who reported the problem
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ technicianjsonAssigned technician
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ reported_timejsonTime the problem was reported
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ due_by_timejsonDue time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ closed_timejsonTime the problem was closed
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ root_causejsonRoot cause analysis
↳ workaround_detailsjsonDocumented workaround
↳ resolution_detailsjsonDocumented resolution
↳ known_error_detailsjsonKnown-error record details
↳ notes_presentbooleanWhether the problem has notes

ManageEngine SDP List Problems

List ManageEngine ServiceDesk Plus Cloud problems, with optional search criteria, sorting and paging.

Input

ParameterTypeRequiredDescription
dataCenterstringNoZoho data center hosting the portal (US, EU, IN, AU, JP, CA, SA, UK, CN, AE). Credentials connected through Sim are issued by the US accounts server and are only valid against US.
portalstringNoPortal URL name. Leave empty to use the account default portal
rowCountnumberNoRows to return (maximum 100)
startIndexnumberNoOne-based index of the first row to return
sortFieldstringNoField to sort on, e.g. created_time
sortOrderstringNoSort direction: asc or desc
searchCriteriajsonNoSearch criteria object or array, e.g. {"field":"status.name","condition":"is","value":"Open"}
fieldsRequiredjsonNoArray of field names to return, e.g. ["subject","status"]
getTotalCountbooleanNoInclude the total matching row count in list_info

Output

ParameterTypeDescription
problemsarrayMatching problems
↳ idstringProblem ID
↳ display_idjsonProblem number shown in the SDP UI (display_value, value)
↳ display_valuestringRecord number as shown in the UI, e.g. PB-140
↳ valuestringBare sequence number, e.g. 140
↳ titlestringProblem title
↳ descriptionstringProblem description (HTML)
↳ statusjsonCurrent status
↳ idstringIdentifier
↳ namestringDisplay name
↳ priorityjsonPriority
↳ idstringIdentifier
↳ namestringDisplay name
↳ urgencyjsonUrgency
↳ idstringIdentifier
↳ namestringDisplay name
↳ impactjsonImpact
↳ idstringIdentifier
↳ namestringDisplay name
↳ categoryjsonCategory
↳ idstringIdentifier
↳ namestringDisplay name
↳ subcategoryjsonSubcategory
↳ idstringIdentifier
↳ namestringDisplay name
↳ groupjsonSupport group
↳ idstringIdentifier
↳ namestringDisplay name
↳ sitejsonSite
↳ idstringIdentifier
↳ namestringDisplay name
↳ reported_byjsonUser who reported the problem
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ technicianjsonAssigned technician
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ reported_timejsonTime the problem was reported
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ due_by_timejsonDue time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ closed_timejsonTime the problem was closed
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ root_causejsonRoot cause analysis
↳ workaround_detailsjsonDocumented workaround
↳ resolution_detailsjsonDocumented resolution
↳ known_error_detailsjsonKnown-error record details
↳ notes_presentbooleanWhether the problem has notes
countnumberNumber of problems returned in this page
listInfoobjectPaging metadata echoed by ServiceDesk Plus
↳ row_countnumberRows returned
↳ start_indexnumberIndex the page started at
↳ pagenumberPage number
↳ has_more_rowsbooleanWhether more rows are available after this page
↳ sort_fieldstringField the results were sorted on
↳ sort_orderstringSort direction
↳ total_countnumberTotal matching rows, present only when get_total_count was requested

ManageEngine SDP Update Problem

Update a ManageEngine ServiceDesk Plus Cloud problem: change its title, status, assignment or classification.

Input

ParameterTypeRequiredDescription
dataCenterstringNoZoho data center hosting the portal (US, EU, IN, AU, JP, CA, SA, UK, CN, AE). Credentials connected through Sim are issued by the US accounts server and are only valid against US.
portalstringNoPortal URL name. Leave empty to use the account default portal
problemIdstringYesID of the problem to update
titlestringNoNew problem title
descriptionstringNoProblem description. HTML is supported
reportedByEmailstringNoEmail address of the user reporting the problem
technicianEmailstringNoEmail address of the technician to assign
prioritystringNoPriority name, e.g. High
statusstringNoStatus name, e.g. Open
urgencystringNoUrgency name
impactstringNoImpact name
categorystringNoCategory name
subcategorystringNoSubcategory name
groupstringNoSupport group name
sitestringNoSite name
udfFieldsjsonNoPortal-defined custom fields, e.g. {"udf_char1":"value"}

Output

ParameterTypeDescription
problemobjectThe updated problem
↳ idstringProblem ID
↳ display_idjsonProblem number shown in the SDP UI (display_value, value)
↳ display_valuestringRecord number as shown in the UI, e.g. PB-140
↳ valuestringBare sequence number, e.g. 140
↳ titlestringProblem title
↳ descriptionstringProblem description (HTML)
↳ statusjsonCurrent status
↳ idstringIdentifier
↳ namestringDisplay name
↳ priorityjsonPriority
↳ idstringIdentifier
↳ namestringDisplay name
↳ urgencyjsonUrgency
↳ idstringIdentifier
↳ namestringDisplay name
↳ impactjsonImpact
↳ idstringIdentifier
↳ namestringDisplay name
↳ categoryjsonCategory
↳ idstringIdentifier
↳ namestringDisplay name
↳ subcategoryjsonSubcategory
↳ idstringIdentifier
↳ namestringDisplay name
↳ groupjsonSupport group
↳ idstringIdentifier
↳ namestringDisplay name
↳ sitejsonSite
↳ idstringIdentifier
↳ namestringDisplay name
↳ reported_byjsonUser who reported the problem
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ technicianjsonAssigned technician
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ reported_timejsonTime the problem was reported
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ due_by_timejsonDue time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ closed_timejsonTime the problem was closed
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ root_causejsonRoot cause analysis
↳ workaround_detailsjsonDocumented workaround
↳ resolution_detailsjsonDocumented resolution
↳ known_error_detailsjsonKnown-error record details
↳ notes_presentbooleanWhether the problem has notes

ManageEngine SDP Delete Problem

Delete a ManageEngine ServiceDesk Plus Cloud problem and its associated notes.

Input

ParameterTypeRequiredDescription
dataCenterstringNoZoho data center hosting the portal (US, EU, IN, AU, JP, CA, SA, UK, CN, AE). Credentials connected through Sim are issued by the US accounts server and are only valid against US.
portalstringNoPortal URL name. Leave empty to use the account default portal
problemIdstringYesID of the problem to delete

Output

ParameterTypeDescription
deletedbooleanWhether the problem was deleted

ManageEngine SDP Add Problem Note

Add a note to a ManageEngine ServiceDesk Plus Cloud problem.

Input

ParameterTypeRequiredDescription
dataCenterstringNoZoho data center hosting the portal (US, EU, IN, AU, JP, CA, SA, UK, CN, AE). Credentials connected through Sim are issued by the US accounts server and are only valid against US.
portalstringNoPortal URL name. Leave empty to use the account default portal
problemIdstringYesID of the problem to add the note to
descriptionstringYesNote body. HTML is supported

Output

ParameterTypeDescription
noteobjectThe created note
↳ idstringNote ID
↳ descriptionstringNote body (HTML)
↳ performed_byjsonNote author
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ performed_timejsonTime the note was added
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string

ManageEngine SDP List Problem Notes

List the notes on a ManageEngine ServiceDesk Plus Cloud problem.

Input

ParameterTypeRequiredDescription
dataCenterstringNoZoho data center hosting the portal (US, EU, IN, AU, JP, CA, SA, UK, CN, AE). Credentials connected through Sim are issued by the US accounts server and are only valid against US.
portalstringNoPortal URL name. Leave empty to use the account default portal
problemIdstringYesID of the problem whose notes to list
rowCountnumberNoRows to return (maximum 100)
startIndexnumberNoOne-based index of the first row to return
sortFieldstringNoField to sort on, e.g. created_time
sortOrderstringNoSort direction: asc or desc
searchCriteriajsonNoSearch criteria object or array, e.g. {"field":"status.name","condition":"is","value":"Open"}
fieldsRequiredjsonNoArray of field names to return, e.g. ["subject","status"]
getTotalCountbooleanNoInclude the total matching row count in list_info

Output

ParameterTypeDescription
notesarrayNotes on the problem
↳ idstringNote ID
↳ descriptionstringNote body (HTML)
↳ performed_byjsonNote author
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ performed_timejsonTime the note was added
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
countnumberNumber of notes returned in this page
listInfoobjectPaging metadata echoed by ServiceDesk Plus
↳ row_countnumberRows returned
↳ start_indexnumberIndex the page started at
↳ pagenumberPage number
↳ has_more_rowsbooleanWhether more rows are available after this page
↳ sort_fieldstringField the results were sorted on
↳ sort_orderstringSort direction
↳ total_countnumberTotal matching rows, present only when get_total_count was requested

ManageEngine SDP Create Change

Create a change record in ManageEngine ServiceDesk Plus Cloud with a title, stage, status and schedule.

Input

ParameterTypeRequiredDescription
dataCenterstringNoZoho data center hosting the portal (US, EU, IN, AU, JP, CA, SA, UK, CN, AE). Credentials connected through Sim are issued by the US accounts server and are only valid against US.
portalstringNoPortal URL name. Leave empty to use the account default portal
titlestringYesChange title
stagestringYesChange stage name, e.g. Submission
statusstringYesChange status name, e.g. Open
descriptionstringNoChange description. HTML is supported
changeTypeNamestringNoChange type name, e.g. Standard
reasonForChangestringNoReason-for-change name
prioritystringNoPriority name
urgencystringNoUrgency name
impactstringNoImpact name
groupstringNoSupport group name
changeRequesterEmailstringNoEmail address of the change requester
changeOwnerEmailstringNoEmail address of the change owner
changeManagerEmailstringNoEmail address of the change manager
scheduledStartTimestringNoScheduled start, as an ISO 8601 timestamp or epoch milliseconds
scheduledEndTimestringNoScheduled end, as an ISO 8601 timestamp or epoch milliseconds
emergencybooleanNoWhether this is an emergency change
commentstringNoReason for the status update. ServiceDesk Plus requires this when status changes
udfFieldsjsonNoPortal-defined custom fields, e.g. {"udf_char1":"value"}

Output

ParameterTypeDescription
changeobjectThe created change
↳ idstringChange ID
↳ display_idjsonChange number shown in the SDP UI (display_value, value)
↳ display_valuestringRecord number as shown in the UI, e.g. PB-140
↳ valuestringBare sequence number, e.g. 140
↳ titlestringChange title
↳ descriptionstringChange description (HTML)
↳ statusjsonCurrent status
↳ idstringIdentifier
↳ namestringDisplay name
↳ internal_namestringInternal status name
↳ stagejsonChange stage
↳ change_typejsonChange type
↳ idstringIdentifier
↳ namestringDisplay name
↳ colorstringType colour
↳ pre_approvedbooleanWhether the type is pre-approved
↳ priorityjsonPriority
↳ idstringIdentifier
↳ namestringDisplay name
↳ urgencyjsonUrgency
↳ idstringIdentifier
↳ namestringDisplay name
↳ impactjsonImpact
↳ idstringIdentifier
↳ namestringDisplay name
↳ approval_statusjsonApproval status
↳ idstringIdentifier
↳ namestringDisplay name
↳ reason_for_changejsonReason for the change
↳ idstringIdentifier
↳ namestringDisplay name
↳ change_requesterjsonUser who requested the change
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ change_ownerjsonChange owner
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ change_managerjsonChange manager
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ groupjsonSupport group
↳ idstringIdentifier
↳ namestringDisplay name
↳ emergencybooleanWhether the change is an emergency
↳ created_timejsonCreation time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ scheduled_start_timejsonScheduled start
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ scheduled_end_timejsonScheduled end
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ roll_out_planjsonRoll-out plan
↳ close_detailsjsonClosure details

ManageEngine SDP Get Change

Retrieve a single ManageEngine ServiceDesk Plus Cloud change by ID.

Input

ParameterTypeRequiredDescription
dataCenterstringNoZoho data center hosting the portal (US, EU, IN, AU, JP, CA, SA, UK, CN, AE). Credentials connected through Sim are issued by the US accounts server and are only valid against US.
portalstringNoPortal URL name. Leave empty to use the account default portal
changeIdstringYesID of the change to retrieve

Output

ParameterTypeDescription
changeobjectThe change
↳ idstringChange ID
↳ display_idjsonChange number shown in the SDP UI (display_value, value)
↳ display_valuestringRecord number as shown in the UI, e.g. PB-140
↳ valuestringBare sequence number, e.g. 140
↳ titlestringChange title
↳ descriptionstringChange description (HTML)
↳ statusjsonCurrent status
↳ idstringIdentifier
↳ namestringDisplay name
↳ internal_namestringInternal status name
↳ stagejsonChange stage
↳ change_typejsonChange type
↳ idstringIdentifier
↳ namestringDisplay name
↳ colorstringType colour
↳ pre_approvedbooleanWhether the type is pre-approved
↳ priorityjsonPriority
↳ idstringIdentifier
↳ namestringDisplay name
↳ urgencyjsonUrgency
↳ idstringIdentifier
↳ namestringDisplay name
↳ impactjsonImpact
↳ idstringIdentifier
↳ namestringDisplay name
↳ approval_statusjsonApproval status
↳ idstringIdentifier
↳ namestringDisplay name
↳ reason_for_changejsonReason for the change
↳ idstringIdentifier
↳ namestringDisplay name
↳ change_requesterjsonUser who requested the change
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ change_ownerjsonChange owner
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ change_managerjsonChange manager
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ groupjsonSupport group
↳ idstringIdentifier
↳ namestringDisplay name
↳ emergencybooleanWhether the change is an emergency
↳ created_timejsonCreation time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ scheduled_start_timejsonScheduled start
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ scheduled_end_timejsonScheduled end
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ roll_out_planjsonRoll-out plan
↳ close_detailsjsonClosure details

ManageEngine SDP List Changes

List ManageEngine ServiceDesk Plus Cloud changes, with optional search criteria, sorting and paging.

Input

ParameterTypeRequiredDescription
dataCenterstringNoZoho data center hosting the portal (US, EU, IN, AU, JP, CA, SA, UK, CN, AE). Credentials connected through Sim are issued by the US accounts server and are only valid against US.
portalstringNoPortal URL name. Leave empty to use the account default portal
rowCountnumberNoRows to return (maximum 100)
startIndexnumberNoOne-based index of the first row to return
sortFieldstringNoField to sort on, e.g. created_time
sortOrderstringNoSort direction: asc or desc
searchCriteriajsonNoSearch criteria object or array, e.g. {"field":"status.name","condition":"is","value":"Open"}
fieldsRequiredjsonNoArray of field names to return, e.g. ["subject","status"]
getTotalCountbooleanNoInclude the total matching row count in list_info

Output

ParameterTypeDescription
changesarrayMatching changes
↳ idstringChange ID
↳ display_idjsonChange number shown in the SDP UI (display_value, value)
↳ display_valuestringRecord number as shown in the UI, e.g. PB-140
↳ valuestringBare sequence number, e.g. 140
↳ titlestringChange title
↳ descriptionstringChange description (HTML)
↳ statusjsonCurrent status
↳ idstringIdentifier
↳ namestringDisplay name
↳ internal_namestringInternal status name
↳ stagejsonChange stage
↳ change_typejsonChange type
↳ idstringIdentifier
↳ namestringDisplay name
↳ colorstringType colour
↳ pre_approvedbooleanWhether the type is pre-approved
↳ priorityjsonPriority
↳ idstringIdentifier
↳ namestringDisplay name
↳ urgencyjsonUrgency
↳ idstringIdentifier
↳ namestringDisplay name
↳ impactjsonImpact
↳ idstringIdentifier
↳ namestringDisplay name
↳ approval_statusjsonApproval status
↳ idstringIdentifier
↳ namestringDisplay name
↳ reason_for_changejsonReason for the change
↳ idstringIdentifier
↳ namestringDisplay name
↳ change_requesterjsonUser who requested the change
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ change_ownerjsonChange owner
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ change_managerjsonChange manager
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ groupjsonSupport group
↳ idstringIdentifier
↳ namestringDisplay name
↳ emergencybooleanWhether the change is an emergency
↳ created_timejsonCreation time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ scheduled_start_timejsonScheduled start
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ scheduled_end_timejsonScheduled end
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ roll_out_planjsonRoll-out plan
↳ close_detailsjsonClosure details
countnumberNumber of changes returned in this page
listInfoobjectPaging metadata echoed by ServiceDesk Plus
↳ row_countnumberRows returned
↳ start_indexnumberIndex the page started at
↳ pagenumberPage number
↳ has_more_rowsbooleanWhether more rows are available after this page
↳ sort_fieldstringField the results were sorted on
↳ sort_orderstringSort direction
↳ total_countnumberTotal matching rows, present only when get_total_count was requested

ManageEngine SDP Update Change

Update a ManageEngine ServiceDesk Plus Cloud change: move its stage or status, reschedule it, or change its assignment. ServiceDesk Plus requires a comment whenever the status changes.

Input

ParameterTypeRequiredDescription
dataCenterstringNoZoho data center hosting the portal (US, EU, IN, AU, JP, CA, SA, UK, CN, AE). Credentials connected through Sim are issued by the US accounts server and are only valid against US.
portalstringNoPortal URL name. Leave empty to use the account default portal
changeIdstringYesID of the change to update
titlestringNoNew change title
stagestringNoChange stage name to set
statusstringNoChange status name to set. Requires a comment
descriptionstringNoChange description. HTML is supported
changeTypeNamestringNoChange type name, e.g. Standard
reasonForChangestringNoReason-for-change name
prioritystringNoPriority name
urgencystringNoUrgency name
impactstringNoImpact name
groupstringNoSupport group name
changeRequesterEmailstringNoEmail address of the change requester
changeOwnerEmailstringNoEmail address of the change owner
changeManagerEmailstringNoEmail address of the change manager
scheduledStartTimestringNoScheduled start, as an ISO 8601 timestamp or epoch milliseconds
scheduledEndTimestringNoScheduled end, as an ISO 8601 timestamp or epoch milliseconds
emergencybooleanNoWhether this is an emergency change
commentstringNoReason for the status update. ServiceDesk Plus requires this when status changes
udfFieldsjsonNoPortal-defined custom fields, e.g. {"udf_char1":"value"}

Output

ParameterTypeDescription
changeobjectThe updated change
↳ idstringChange ID
↳ display_idjsonChange number shown in the SDP UI (display_value, value)
↳ display_valuestringRecord number as shown in the UI, e.g. PB-140
↳ valuestringBare sequence number, e.g. 140
↳ titlestringChange title
↳ descriptionstringChange description (HTML)
↳ statusjsonCurrent status
↳ idstringIdentifier
↳ namestringDisplay name
↳ internal_namestringInternal status name
↳ stagejsonChange stage
↳ change_typejsonChange type
↳ idstringIdentifier
↳ namestringDisplay name
↳ colorstringType colour
↳ pre_approvedbooleanWhether the type is pre-approved
↳ priorityjsonPriority
↳ idstringIdentifier
↳ namestringDisplay name
↳ urgencyjsonUrgency
↳ idstringIdentifier
↳ namestringDisplay name
↳ impactjsonImpact
↳ idstringIdentifier
↳ namestringDisplay name
↳ approval_statusjsonApproval status
↳ idstringIdentifier
↳ namestringDisplay name
↳ reason_for_changejsonReason for the change
↳ idstringIdentifier
↳ namestringDisplay name
↳ change_requesterjsonUser who requested the change
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ change_ownerjsonChange owner
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ change_managerjsonChange manager
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ groupjsonSupport group
↳ idstringIdentifier
↳ namestringDisplay name
↳ emergencybooleanWhether the change is an emergency
↳ created_timejsonCreation time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ scheduled_start_timejsonScheduled start
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ scheduled_end_timejsonScheduled end
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ roll_out_planjsonRoll-out plan
↳ close_detailsjsonClosure details

ManageEngine SDP Delete Change

Delete a ManageEngine ServiceDesk Plus Cloud change and its associated notes.

Input

ParameterTypeRequiredDescription
dataCenterstringNoZoho data center hosting the portal (US, EU, IN, AU, JP, CA, SA, UK, CN, AE). Credentials connected through Sim are issued by the US accounts server and are only valid against US.
portalstringNoPortal URL name. Leave empty to use the account default portal
changeIdstringYesID of the change to delete

Output

ParameterTypeDescription
deletedbooleanWhether the change was deleted

ManageEngine SDP Add Change Note

Add a note to a ManageEngine ServiceDesk Plus Cloud change.

Input

ParameterTypeRequiredDescription
dataCenterstringNoZoho data center hosting the portal (US, EU, IN, AU, JP, CA, SA, UK, CN, AE). Credentials connected through Sim are issued by the US accounts server and are only valid against US.
portalstringNoPortal URL name. Leave empty to use the account default portal
changeIdstringYesID of the change to add the note to
descriptionstringYesNote body. HTML is supported

Output

ParameterTypeDescription
noteobjectThe created note
↳ idstringNote ID
↳ descriptionstringNote body (HTML)
↳ performed_byjsonNote author
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ performed_timejsonTime the note was added
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string

ManageEngine SDP List Change Notes

List the notes on a ManageEngine ServiceDesk Plus Cloud change.

Input

ParameterTypeRequiredDescription
dataCenterstringNoZoho data center hosting the portal (US, EU, IN, AU, JP, CA, SA, UK, CN, AE). Credentials connected through Sim are issued by the US accounts server and are only valid against US.
portalstringNoPortal URL name. Leave empty to use the account default portal
changeIdstringYesID of the change whose notes to list
rowCountnumberNoRows to return (maximum 100)
startIndexnumberNoOne-based index of the first row to return
sortFieldstringNoField to sort on, e.g. created_time
sortOrderstringNoSort direction: asc or desc
searchCriteriajsonNoSearch criteria object or array, e.g. {"field":"status.name","condition":"is","value":"Open"}
fieldsRequiredjsonNoArray of field names to return, e.g. ["subject","status"]
getTotalCountbooleanNoInclude the total matching row count in list_info

Output

ParameterTypeDescription
notesarrayNotes on the change
↳ idstringNote ID
↳ descriptionstringNote body (HTML)
↳ performed_byjsonNote author
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ performed_timejsonTime the note was added
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
countnumberNumber of notes returned in this page
listInfoobjectPaging metadata echoed by ServiceDesk Plus
↳ row_countnumberRows returned
↳ start_indexnumberIndex the page started at
↳ pagenumberPage number
↳ has_more_rowsbooleanWhether more rows are available after this page
↳ sort_fieldstringField the results were sorted on
↳ sort_orderstringSort direction
↳ total_countnumberTotal matching rows, present only when get_total_count was requested

ManageEngine SDP Create Asset

Create an asset in the ManageEngine ServiceDesk Plus Cloud inventory. Requires a name and an existing product.

Input

ParameterTypeRequiredDescription
dataCenterstringNoZoho data center hosting the portal (US, EU, IN, AU, JP, CA, SA, UK, CN, AE). Credentials connected through Sim are issued by the US accounts server and are only valid against US.
portalstringNoPortal URL name. Leave empty to use the account default portal
namestringYesAsset name
productstringYesName of an existing product this asset is an instance of
productTypestringNoProduct type name, e.g. Laptop
assetTagstringNoAsset tag
serialNumberstringNoSerial number
barcodestringNoBarcode
ipAddressstringNoIP address
macAddressstringNoMAC address
locationstringNoLocation
statestringNoAsset state name, e.g. In Use
vendorstringNoVendor name
departmentstringNoDepartment name
sitestringNoSite name
userEmailstringNoEmail address of the user the asset is assigned to
stateHistoryCommentsstringNoComment recorded against a state change
udfFieldsjsonNoPortal-defined custom fields, e.g. {"udf_char1":"value"}

Output

ParameterTypeDescription
assetobjectThe created asset
↳ idstringAsset ID
↳ namestringAsset name
↳ asset_tagstringAsset tag
↳ barcodestringBarcode
↳ serial_numberstringSerial number
↳ ip_addressstringIP address
↳ mac_addressstringMAC address
↳ locationstringLocation
↳ statejsonAsset state (In Use, In Store, ...)
↳ idstringIdentifier
↳ namestringDisplay name
↳ descriptionstringState description
↳ productjsonProduct this asset is an instance of
↳ idstringIdentifier
↳ namestringDisplay name
↳ manufacturerstringManufacturer
↳ part_nostringPart number
↳ product_typejsonProduct type
↳ idstringIdentifier
↳ namestringDisplay name
↳ vendorjsonVendor
↳ idstringIdentifier
↳ namestringDisplay name
↳ departmentjsonOwning department
↳ idstringIdentifier
↳ namestringDisplay name
↳ sitejsonSite
↳ idstringIdentifier
↳ namestringDisplay name
↳ userjsonUser the asset is assigned to
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ purchase_costnumberPurchase cost
↳ total_costnumberTotal cost
↳ acquisition_datejsonAcquisition date
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ expiry_datejsonExpiry date
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ warranty_expiryjsonWarranty expiry date
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ is_loanedbooleanWhether the asset is on loan
↳ is_in_contractbooleanWhether the asset is covered by a contract

ManageEngine SDP Get Asset

Retrieve a single ManageEngine ServiceDesk Plus Cloud asset by ID.

Input

ParameterTypeRequiredDescription
dataCenterstringNoZoho data center hosting the portal (US, EU, IN, AU, JP, CA, SA, UK, CN, AE). Credentials connected through Sim are issued by the US accounts server and are only valid against US.
portalstringNoPortal URL name. Leave empty to use the account default portal
assetIdstringYesID of the asset to retrieve

Output

ParameterTypeDescription
assetobjectThe asset
↳ idstringAsset ID
↳ namestringAsset name
↳ asset_tagstringAsset tag
↳ barcodestringBarcode
↳ serial_numberstringSerial number
↳ ip_addressstringIP address
↳ mac_addressstringMAC address
↳ locationstringLocation
↳ statejsonAsset state (In Use, In Store, ...)
↳ idstringIdentifier
↳ namestringDisplay name
↳ descriptionstringState description
↳ productjsonProduct this asset is an instance of
↳ idstringIdentifier
↳ namestringDisplay name
↳ manufacturerstringManufacturer
↳ part_nostringPart number
↳ product_typejsonProduct type
↳ idstringIdentifier
↳ namestringDisplay name
↳ vendorjsonVendor
↳ idstringIdentifier
↳ namestringDisplay name
↳ departmentjsonOwning department
↳ idstringIdentifier
↳ namestringDisplay name
↳ sitejsonSite
↳ idstringIdentifier
↳ namestringDisplay name
↳ userjsonUser the asset is assigned to
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ purchase_costnumberPurchase cost
↳ total_costnumberTotal cost
↳ acquisition_datejsonAcquisition date
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ expiry_datejsonExpiry date
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ warranty_expiryjsonWarranty expiry date
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ is_loanedbooleanWhether the asset is on loan
↳ is_in_contractbooleanWhether the asset is covered by a contract

ManageEngine SDP List Assets

List ManageEngine ServiceDesk Plus Cloud assets, with optional search criteria, sorting and paging.

Input

ParameterTypeRequiredDescription
dataCenterstringNoZoho data center hosting the portal (US, EU, IN, AU, JP, CA, SA, UK, CN, AE). Credentials connected through Sim are issued by the US accounts server and are only valid against US.
portalstringNoPortal URL name. Leave empty to use the account default portal
rowCountnumberNoRows to return (maximum 100)
startIndexnumberNoOne-based index of the first row to return
sortFieldstringNoField to sort on, e.g. created_time
sortOrderstringNoSort direction: asc or desc
searchCriteriajsonNoSearch criteria object or array, e.g. {"field":"status.name","condition":"is","value":"Open"}
fieldsRequiredjsonNoArray of field names to return, e.g. ["subject","status"]
getTotalCountbooleanNoInclude the total matching row count in list_info

Output

ParameterTypeDescription
assetsarrayMatching assets
↳ idstringAsset ID
↳ namestringAsset name
↳ asset_tagstringAsset tag
↳ barcodestringBarcode
↳ serial_numberstringSerial number
↳ ip_addressstringIP address
↳ mac_addressstringMAC address
↳ locationstringLocation
↳ statejsonAsset state (In Use, In Store, ...)
↳ idstringIdentifier
↳ namestringDisplay name
↳ descriptionstringState description
↳ productjsonProduct this asset is an instance of
↳ idstringIdentifier
↳ namestringDisplay name
↳ manufacturerstringManufacturer
↳ part_nostringPart number
↳ product_typejsonProduct type
↳ idstringIdentifier
↳ namestringDisplay name
↳ vendorjsonVendor
↳ idstringIdentifier
↳ namestringDisplay name
↳ departmentjsonOwning department
↳ idstringIdentifier
↳ namestringDisplay name
↳ sitejsonSite
↳ idstringIdentifier
↳ namestringDisplay name
↳ userjsonUser the asset is assigned to
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ purchase_costnumberPurchase cost
↳ total_costnumberTotal cost
↳ acquisition_datejsonAcquisition date
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ expiry_datejsonExpiry date
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ warranty_expiryjsonWarranty expiry date
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ is_loanedbooleanWhether the asset is on loan
↳ is_in_contractbooleanWhether the asset is covered by a contract
countnumberNumber of assets returned in this page
listInfoobjectPaging metadata echoed by ServiceDesk Plus
↳ row_countnumberRows returned
↳ start_indexnumberIndex the page started at
↳ pagenumberPage number
↳ has_more_rowsbooleanWhether more rows are available after this page
↳ sort_fieldstringField the results were sorted on
↳ sort_orderstringSort direction
↳ total_countnumberTotal matching rows, present only when get_total_count was requested

ManageEngine SDP Update Asset

Update a ManageEngine ServiceDesk Plus Cloud asset: reassign it, change its state, or correct its inventory details.

Input

ParameterTypeRequiredDescription
dataCenterstringNoZoho data center hosting the portal (US, EU, IN, AU, JP, CA, SA, UK, CN, AE). Credentials connected through Sim are issued by the US accounts server and are only valid against US.
portalstringNoPortal URL name. Leave empty to use the account default portal
assetIdstringYesID of the asset to update
namestringNoNew asset name
productstringNoName of an existing product to reassign the asset to
productTypestringNoProduct type name, e.g. Laptop
assetTagstringNoAsset tag
serialNumberstringNoSerial number
barcodestringNoBarcode
ipAddressstringNoIP address
macAddressstringNoMAC address
locationstringNoLocation
statestringNoAsset state name, e.g. In Use
vendorstringNoVendor name
departmentstringNoDepartment name
sitestringNoSite name
userEmailstringNoEmail address of the user the asset is assigned to
stateHistoryCommentsstringNoComment recorded against a state change
udfFieldsjsonNoPortal-defined custom fields, e.g. {"udf_char1":"value"}

Output

ParameterTypeDescription
assetobjectThe updated asset
↳ idstringAsset ID
↳ namestringAsset name
↳ asset_tagstringAsset tag
↳ barcodestringBarcode
↳ serial_numberstringSerial number
↳ ip_addressstringIP address
↳ mac_addressstringMAC address
↳ locationstringLocation
↳ statejsonAsset state (In Use, In Store, ...)
↳ idstringIdentifier
↳ namestringDisplay name
↳ descriptionstringState description
↳ productjsonProduct this asset is an instance of
↳ idstringIdentifier
↳ namestringDisplay name
↳ manufacturerstringManufacturer
↳ part_nostringPart number
↳ product_typejsonProduct type
↳ idstringIdentifier
↳ namestringDisplay name
↳ vendorjsonVendor
↳ idstringIdentifier
↳ namestringDisplay name
↳ departmentjsonOwning department
↳ idstringIdentifier
↳ namestringDisplay name
↳ sitejsonSite
↳ idstringIdentifier
↳ namestringDisplay name
↳ userjsonUser the asset is assigned to
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ purchase_costnumberPurchase cost
↳ total_costnumberTotal cost
↳ acquisition_datejsonAcquisition date
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ expiry_datejsonExpiry date
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ warranty_expiryjsonWarranty expiry date
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ is_loanedbooleanWhether the asset is on loan
↳ is_in_contractbooleanWhether the asset is covered by a contract

ManageEngine SDP Delete Asset

Delete an asset from the ManageEngine ServiceDesk Plus Cloud inventory.

Input

ParameterTypeRequiredDescription
dataCenterstringNoZoho data center hosting the portal (US, EU, IN, AU, JP, CA, SA, UK, CN, AE). Credentials connected through Sim are issued by the US accounts server and are only valid against US.
portalstringNoPortal URL name. Leave empty to use the account default portal
assetIdstringYesID of the asset to delete

Output

ParameterTypeDescription
deletedbooleanWhether the asset was deleted

ManageEngine SDP Create Solution

Add an article to the ManageEngine ServiceDesk Plus Cloud knowledge base under an existing topic.

Input

ParameterTypeRequiredDescription
dataCenterstringNoZoho data center hosting the portal (US, EU, IN, AU, JP, CA, SA, UK, CN, AE). Credentials connected through Sim are issued by the US accounts server and are only valid against US.
portalstringNoPortal URL name. Leave empty to use the account default portal
titlestringYesSolution title
descriptionstringYesSolution body. HTML is supported
topicstringYesName of an existing knowledge base topic to file the solution under
keywordsstringNoSearch keywords for the solution
isPublicbooleanNoWhether requesters can see the solution. Only takes effect once the solution is Approved
udfFieldsjsonNoPortal-defined custom fields, e.g. {"udf_char1":"value"}

Output

ParameterTypeDescription
solutionobjectThe created solution
↳ idstringSolution ID
↳ display_idjsonSolution number shown in the SDP UI (display_value, value)
↳ display_valuestringRecord number as shown in the UI, e.g. PB-140
↳ valuestringBare sequence number, e.g. 140
↳ titlestringSolution title
↳ descriptionstringSolution body (HTML)
↳ topicjsonTopic the solution is filed under
↳ idstringIdentifier
↳ namestringDisplay name
↳ parent_topicjsonParent topic
↳ approval_statusjsonApproval status
↳ idstringIdentifier
↳ namestringDisplay name
↳ keywordsstringSearch keywords
↳ is_publicbooleanWhether requesters can see the solution
↳ likesnumberLike count
↳ dislikesnumberDislike count
↳ no_of_hitsnumberView count
↳ created_timejsonCreation time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ last_updated_timejsonLast update time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ review_datejsonDate the solution is due for review
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ expiry_datejsonDate the solution expires
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ created_byjsonAuthor
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ last_updated_byjsonUser who last updated the solution
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ udf_fieldsjsonPortal-defined custom fields

ManageEngine SDP Get Solution

Retrieve a single ManageEngine ServiceDesk Plus Cloud knowledge base solution by ID.

Input

ParameterTypeRequiredDescription
dataCenterstringNoZoho data center hosting the portal (US, EU, IN, AU, JP, CA, SA, UK, CN, AE). Credentials connected through Sim are issued by the US accounts server and are only valid against US.
portalstringNoPortal URL name. Leave empty to use the account default portal
solutionIdstringYesID of the solution to retrieve

Output

ParameterTypeDescription
solutionobjectThe solution
↳ idstringSolution ID
↳ display_idjsonSolution number shown in the SDP UI (display_value, value)
↳ display_valuestringRecord number as shown in the UI, e.g. PB-140
↳ valuestringBare sequence number, e.g. 140
↳ titlestringSolution title
↳ descriptionstringSolution body (HTML)
↳ topicjsonTopic the solution is filed under
↳ idstringIdentifier
↳ namestringDisplay name
↳ parent_topicjsonParent topic
↳ approval_statusjsonApproval status
↳ idstringIdentifier
↳ namestringDisplay name
↳ keywordsstringSearch keywords
↳ is_publicbooleanWhether requesters can see the solution
↳ likesnumberLike count
↳ dislikesnumberDislike count
↳ no_of_hitsnumberView count
↳ created_timejsonCreation time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ last_updated_timejsonLast update time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ review_datejsonDate the solution is due for review
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ expiry_datejsonDate the solution expires
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ created_byjsonAuthor
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ last_updated_byjsonUser who last updated the solution
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ udf_fieldsjsonPortal-defined custom fields

ManageEngine SDP List Solutions

Search the ManageEngine ServiceDesk Plus Cloud knowledge base, with optional search criteria, sorting and paging.

Input

ParameterTypeRequiredDescription
dataCenterstringNoZoho data center hosting the portal (US, EU, IN, AU, JP, CA, SA, UK, CN, AE). Credentials connected through Sim are issued by the US accounts server and are only valid against US.
portalstringNoPortal URL name. Leave empty to use the account default portal
rowCountnumberNoRows to return (maximum 100)
startIndexnumberNoOne-based index of the first row to return
sortFieldstringNoField to sort on, e.g. created_time
sortOrderstringNoSort direction: asc or desc
searchCriteriajsonNoSearch criteria object or array, e.g. {"field":"status.name","condition":"is","value":"Open"}
fieldsRequiredjsonNoArray of field names to return, e.g. ["subject","status"]
getTotalCountbooleanNoInclude the total matching row count in list_info

Output

ParameterTypeDescription
solutionsarrayMatching solutions
↳ idstringSolution ID
↳ display_idjsonSolution number shown in the SDP UI (display_value, value)
↳ display_valuestringRecord number as shown in the UI, e.g. PB-140
↳ valuestringBare sequence number, e.g. 140
↳ titlestringSolution title
↳ descriptionstringSolution body (HTML)
↳ topicjsonTopic the solution is filed under
↳ idstringIdentifier
↳ namestringDisplay name
↳ parent_topicjsonParent topic
↳ approval_statusjsonApproval status
↳ idstringIdentifier
↳ namestringDisplay name
↳ keywordsstringSearch keywords
↳ is_publicbooleanWhether requesters can see the solution
↳ likesnumberLike count
↳ dislikesnumberDislike count
↳ no_of_hitsnumberView count
↳ created_timejsonCreation time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ last_updated_timejsonLast update time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ review_datejsonDate the solution is due for review
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ expiry_datejsonDate the solution expires
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ created_byjsonAuthor
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ last_updated_byjsonUser who last updated the solution
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ udf_fieldsjsonPortal-defined custom fields
countnumberNumber of solutions returned in this page
listInfoobjectPaging metadata echoed by ServiceDesk Plus
↳ row_countnumberRows returned
↳ start_indexnumberIndex the page started at
↳ pagenumberPage number
↳ has_more_rowsbooleanWhether more rows are available after this page
↳ sort_fieldstringField the results were sorted on
↳ sort_orderstringSort direction
↳ total_countnumberTotal matching rows, present only when get_total_count was requested

ManageEngine SDP Update Solution

Update a ManageEngine ServiceDesk Plus Cloud knowledge base solution: revise its body, retitle it, or move it to another topic.

Input

ParameterTypeRequiredDescription
dataCenterstringNoZoho data center hosting the portal (US, EU, IN, AU, JP, CA, SA, UK, CN, AE). Credentials connected through Sim are issued by the US accounts server and are only valid against US.
portalstringNoPortal URL name. Leave empty to use the account default portal
solutionIdstringYesID of the solution to update
titlestringNoNew solution title
descriptionstringNoNew solution body. HTML is supported
topicstringNoName of an existing topic to move the solution to
keywordsstringNoSearch keywords for the solution
isPublicbooleanNoWhether requesters can see the solution. Only takes effect once the solution is Approved
udfFieldsjsonNoPortal-defined custom fields, e.g. {"udf_char1":"value"}

Output

ParameterTypeDescription
solutionobjectThe updated solution
↳ idstringSolution ID
↳ display_idjsonSolution number shown in the SDP UI (display_value, value)
↳ display_valuestringRecord number as shown in the UI, e.g. PB-140
↳ valuestringBare sequence number, e.g. 140
↳ titlestringSolution title
↳ descriptionstringSolution body (HTML)
↳ topicjsonTopic the solution is filed under
↳ idstringIdentifier
↳ namestringDisplay name
↳ parent_topicjsonParent topic
↳ approval_statusjsonApproval status
↳ idstringIdentifier
↳ namestringDisplay name
↳ keywordsstringSearch keywords
↳ is_publicbooleanWhether requesters can see the solution
↳ likesnumberLike count
↳ dislikesnumberDislike count
↳ no_of_hitsnumberView count
↳ created_timejsonCreation time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ last_updated_timejsonLast update time
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ review_datejsonDate the solution is due for review
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ expiry_datejsonDate the solution expires
↳ display_valuestringHuman-readable timestamp in the portal timezone
↳ valuestringEpoch milliseconds as a string
↳ created_byjsonAuthor
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ last_updated_byjsonUser who last updated the solution
↳ idstringUser ID
↳ namestringUser name
↳ email_idstringEmail address
↳ phonestringPhone number
↳ mobilestringMobile number
↳ is_technicianbooleanWhether the user is a technician
↳ is_vip_userbooleanWhether the user is flagged VIP
↳ job_titlestringJob title
↳ udf_fieldsjsonPortal-defined custom fields

ManageEngine SDP Delete Solution

Delete an article from the ManageEngine ServiceDesk Plus Cloud knowledge base, along with its comments and versions.

Input

ParameterTypeRequiredDescription
dataCenterstringNoZoho data center hosting the portal (US, EU, IN, AU, JP, CA, SA, UK, CN, AE). Credentials connected through Sim are issued by the US accounts server and are only valid against US.
portalstringNoPortal URL name. Leave empty to use the account default portal
solutionIdstringYesID of the solution to delete

Output

ParameterTypeDescription
deletedbooleanWhether the solution was deleted