Skip to main content

TOPdesk

This Integration is part of the TOPdesk Pack.#

TOPdesk’s Enterprise Service Management software (ESM) lets your service teams join forces and process requests from a single platform. This integration was integrated and tested with 10.08.008-on-premises-release3-build2 for Linux x86 64-bit of TOPdesk.

Use cases#

  1. Get, update, and create TOPdesk incidents, as well as (de-)escalate, (un)archive or upload files to the incidents.
  2. Fetch newly created TOPdesk incidents.
  3. Get information about branches, persons and operators.

Configure TOPdesk on Cortex XSOAR#

  1. Navigate to Settings > Integrations > Servers & Services.

  2. Search for TOPdesk.

  3. Click Add instance to create and configure a new integration instance.

    ParameterDescriptionRequired
    Server URL (e.g., https://topdesk.mydomain/tas/)The server url.True
    UsernameSee section about auth details belowTrue
    PasswordSee section about auth details belowTrue
    Fetch incidentsFalse
    Maximum number of incidents per fetchFalse
    First fetch time (<number> <time unit>, e.g., 12 hours, 7 days, 3 months, 1 year)False
    Default Incident Caller IDThe default caller ID which is added when creating new TOPdesk incidents and no explicit caller ID is provided. See See Finding the Default Incident Caller ID.False
    The query to use when fetching incidentsGetting incidents with new style FIQL query is available only from TOPdeskRestAPI version 3.4.0. For earlier versions this field will be used as additional inline params as supported.False
    Incident typeUse TOPdesk Incident for some predefined layoutsFalse
    Trust any certificate (not secure)False
    Use system proxy settingsFalse

  4. Click Test to validate the URLs, token, and connection.

Auth Details#

Person and operator are TOPdesk's user types. Each user type has a different set of actions that he is allowed to perform. For example, a person can only update incidents he created, while an operator can update a wider range of incidents.

In general, if an account is able to preform the requested command in TOPdesk's UI, it should be able to preform it using this integration. Make sure you use the right account for your needs and that the account used has all the required permissions.

Setup TOPdesk's application password#

  1. Login to TOPdesk with the designated account.
  2. In TOPdesk, click Open user menu (top right side of the front page) > Choose My settings
  3. At the bottom of the page should be an Application passwords section. You can view all application passwords that are configured for the logged in account.
  4. At the bottom right corner, click Add.
  5. A window should open requesting a name for the application. Choose any convenient name (e.g., XSOAR-key) and click Create.
  6. The application password should be shown - copy it to a safe location. This is the password that will be used for the integration in XSOAR.
  7. Once copied for further usage you can click Close.

Configure Username and Password#

Username: Use the account username from which the application password was generated. (Not the key name)

Password: Use the application password generated in step 6 of the Setup TOPdesk's application password procedure.

Troubleshooting#

Make sure the application password is not expired by logging in TOPdesk and viewing it as described in step 3 of the Setup TOPdesk's application password procedure.

Finding the Default Incident Caller ID#

The TOPdesk incident caller is the TOPdesk person who requested a specific TOPdesk incident and is the contact person for all activities related to this incident.
To find the incident caller ID which should be used as the default caller when creating a new TOPdesk incident, first configure the integration instance without providing the Default Incident Caller ID. Then run the command !topdesk-persons-list in the Playground - War Room.
You will receive a list of people and their IDs. Copy the ID of the desired person and edit the integration instance to set the Default Incident Caller ID.

Incident Mirroring#

You can enable incident mirroring between Cortex XSOAR incidents and TOPdesk incidents.

To setup the mirroring follow these instructions:

  1. Navigate to Settings > Integrations > Servers & Services.
  2. Search for TOPdesk and select your integration instance.
  3. Enable Fetches incidents.
  4. In the Mirroring Direction integration parameter, select in which direction the incidents should be mirrored:
    • Incoming - Any changes in TOPdesk incidents (processingStatus, priority, urgency, impact) will be reflected in Cortex XSOAR incidents.
    • Outgoing - Any changes in Cortex XSOAR incidents will be reflected in TOPdesk incidents (processingStatus, priority, urgency, impact).
    • Incoming And Outgoing - Changes in Cortex XSOAR incidents and TOPdesk incidents will be reflected in both directions.
    • None - Turns off incident mirroring.
  5. The Comment Entry Tag, Work Note Entry Tag and File Entry Tag integration parameters can be used to specify which comments and attachments should be mirrored to TOPdesk. When the tag Comment Entry Tag is used, the comment is visible to the operator and the person. If the tag Work Note Entry Tag is used, the comment is only visible to the operator and the tag File Entry Tag is used to mirror files from Cortex XSOAR to TOPdesk.
  6. Optional: Check the Close Mirrored XSOAR Incident integration parameter to close the Cortex XSOAR incident when the corresponding incident is closed in TOPdesk.
  7. Optional: Check the Close Mirrored TOPdesk Incident integration parameter to close the TOPdesk incident when the corresponding Cortex XSOAR incident is closed.

Newly fetched incidents will be mirrored in the chosen direction. However, this selection does not affect existing incidents.

Important Notes To ensure the mirroring works as expected, mappers are required, both for incoming and outgoing, to map the expected fields in Cortex XSOAR and TOPdesk.

FIQL query#

A few implemented commands can get a query as a parameter. A partial list of these commands:

  • topdesk-incidents-list
  • topdesk-branches-list
  • topdesk-persons-list
  • topdesk-operators-list

While the new versions of TOPdesk all use the new FIQL query format, older versions use limited inline parameters for filters in the requests. Specifically there are 2 versions being used:

TOPdeskRestAPI#

Implements: topdesk-incidents-list

Supports FIQL query version 3.3.0 and higher.

Conveniently, TOPdeskRestAPI also provides an endpoint revealing the API version. Therefore, once the integration is configured, it automatically translates FIQL query to inline parameters and vice versa depending on the TOPdesk version.

SupportingFilesAPI#

Implements: topdesk-branches-list, topdesk-persons-list, topdesk-operators-list

Supports FIQL query version 1.38.0 and higher.

Unlike TOPdeskRestAPI, SupportingFilesAPI does not currently provide an endpoint revealing the API version. Therefore, this integration only supports SupportingFilesAPI version 1.38.0 and higher.

Commands#

You can execute these commands from the Cortex XSOAR CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.

topdesk-subcategories-list#

Get list of subcategories.

Permissions#

Operator: 1st/2nd line incident permissions; Category/Branch/Operator filters apply.

Person: Unrestricted access.

Base Command#

topdesk-subcategories-list

Input#

Argument NameDescriptionRequired
limitThe limit for the amount of subcategories to store in the Context Data. -1 stores all categories. Default value is 100.Optional

Context Output#

PathTypeDescription
TOPdesk.Subcategory.IdStringSubcategory ID.
TOPdesk.Subcategory.NameStringSubcategory name.
TOPdesk.Subcategory.Category.IdStringCategory ID of the subcategory.
TOPdesk.Subcategory.Category.NameStringCategory name of the subcategory.

Command Example#

!topdesk-subcategories-list

Context Example#

{
"TOPdesk": {
"Subcategories": [
{
"Category": {
"Id": "some-category-id-1",
"Name": "User Security"
},
"Id": "some-subcategory-id-1",
"Name": "Endpoint Security"
},
{
"Category": {
"Id": "some-category-id-1",
"Name": "User Security"
},
"Id": "some-subcategory-id-2",
"Name": "Mobile Threat Prevention"
}
]
}
}

Human Readable Output#

TOPdesk subcategories#

IdNameCategoryIdCategoryName
some-subcategory-id-1Endpoint Securitysome-category-idUser Security
some-subcategory-id-2Mobile Threat Preventionsome-category-idUser Security

topdesk-categories-list#

Get list of categories.

Permissions#

Operator: With 1st/2nd line incident permission; Category/Branch/Operator filters apply

Person: Unrestricted access

Base Command#

topdesk-categories-list

Input#

Argument NameDescriptionRequired
limitThe limit for the amount of categories to store in the Context Data. -1 stores all categories. Default value is 100.Optional

Context Output#

PathTypeDescription
TOPdesk.Category.IdStringCategory ID.
TOPdesk.Category.NameStringCategory name.

Command Example#

!topdesk-categories-list

Context Example#

{
"TOPdesk": {
"Category": [
{
"Id": "some-category-id-1",
"Name": "User Security"
},
{
"Id": "some-category-id-2",
"Name": "Network Security"
}
]
}
}

Human Readable Output#

TOPdesk categories#

IdName
some-category-id-1User Security
some-category-id-2Network Security

topdesk-entry-types-list#

Get list of entry types.

Permissions#

Operator: With 1st/2nd line incident permission; Category/Branch/Operator filters apply

Person: No access

Base Command#

topdesk-entry-types-list

Input#

Argument NameDescriptionRequired
limitThe limit for the amount of entry types to store in the Context Data. -1 stores all categories. Default value is 100.Optional

Context Output#

PathTypeDescription
TOPdesk.EntryType.IdStringEntryType ID.
TOPdesk.EntryType.NameStringEntryType name.

Command Example#

!topdesk-entry-types-list

Context Example#

{
"TOPdesk": {
"EntryType": [
{
"Id": "some-entry-type-id-1",
"Name": "Self Service Desk"
},
{
"Id": "some-entry-type-id-2",
"Name": "Telephone"
}
]
}
}

Human Readable Output#

TOPdesk entry types#

IdName
some-entry-type-id-1Self Service Desk
some-entry-type-id-2Telephone

topdesk-call-types-list#

Get list of entry types.

Permissions#

Operator: With 1st/2nd line incident permission; Category/Branch/Operator filters apply

Person: Unrestricted access

Base Command#

topdesk-call-types-list

Input#

Argument NameDescriptionRequired
limitThe limit for the amount of call types to store in the Context Data. -1 stores all categories. Default value is 100.Optional

Context Output#

PathTypeDescription
TOPdesk.CallType.IdStringCallType ID.
TOPdesk.CallType.NameStringCallType name.

Command Example#

!topdesk-call-types-list

Context Example#

{
"TOPdesk": {
"CallType": [
{
"Id": "some-call-type-id-1",
"Name": "Request for Information"
},
{
"Id": "some-call-type-id-2",
"Name": "Problem"
}
]
}
}

Human Readable Output#

TOPdesk call types#

IdName
some-call-type-id-1Request for Information
some-call-type-id-2Problem

topdesk-deescalation-reasons-list#

Get list of deescalation reasons.

Permissions#

Operator: With 1st and 2nd line incident write permission; Feature must be enabled.

Person: No access

Base Command#

topdesk-deescalation-reasons-list

Input#

Argument NameDescriptionRequired
limitThe limit for the amount of deescalation reasons to store in the Context Data. -1 stores all categories. Default value is 100.Optional

Context Output#

PathTypeDescription
TOPdesk.DeescalationReason.IdStringDeescalation reason ID.
TOPdesk.DeescalationReason.NameStringDeescalation reason name.

Command Example#

!topdesk-deescalation-reasons-list

Context Example#

{
"TOPdesk": {
"DeescalationReason": [
{
"Id": "some-deescalation-reason-id-1",
"Name": "Resolves after reset"
},
{
"Id": "some-deescalation-reason-id-2",
"Name": "Workaround exists"
}
]
}
}

Human Readable Output#

IdName
some-deescalation-reason-id-1Resolves after reset
some-deescalation-reason-id-2Workaround exists

topdesk-escalation-reasons-list#

Get list of escalation reasons.

Permissions#

Operator: With 1st line incident write permission and write permission for escalating incidents

Person: No access

Base Command#

topdesk-escalation-reasons-list

Input#

Argument NameDescriptionRequired
limitThe limit for the amount of escalation reasons to store in the Context Data. -1 stores all categories. Default value is 100.Optional

Context Output#

PathTypeDescription
TOPdesk.EscalationReason.IdStringEscalation reason ID.
TOPdesk.EscalationReason.NameStringEscalation reason name.

Command Example#

!topdesk-escalation-reasons-list

Context Example#

{
"TOPdesk": {
"EscalationReason": [
{
"Id": "some-escalation-reason-id-1",
"Name": "Call from president"
},
{
"Id": "some-escalation-reason-id-2",
"Name": "Money is being lost"
}
]
}
}

Human Readable Output#

TOPdesk escalation reasons#

IdName
some-escalation-reason-id-1Call from president
some-escalation-reason-id-2Money is being lost

topdesk-archiving-reasons-list#

Get list of archiving reasons.

Permissions#

Operator: Incident write permission and archiving permission; Category/Branch/Operator filters apply;

Person: No access

Base Command#

topdesk-archiving-reasons-list

Input#

Argument NameDescriptionRequired
limitThe limit for the amount of archiving reasons to store in the Context Data. -1 stores all categories. Default value is 100.Optional

Context Output#

PathTypeDescription
TOPdesk.ArchiveReason.IdStringArchiving reason ID.
TOPdesk.ArchiveReason.NameStringArchiving reason name.

Command Example#

!topdesk-archiving-reasons-list

Context Example#

{
"TOPdesk": {
"ArchiveReason": [
{
"Id": "some-archive-reason-id-1",
"Name": "No longer valid"
},
{
"Id": "some-archive-reason-id-2",
"Name": "No longer employed"
}
]
}
}

Human Readable Output#

TOPdesk archiving reasons#

IdName
some-archive-reason-id-1No longer valid
some-archive-reason-id-2No longer employed

topdesk-persons-list#

Get list of persons.

Permissions#

Operator: With read permission on persons; Branch filters apply

Visible fields in response: all

Person: Only accessible when phonebook is enabled.

Visible fields in response: id, dynamicName, phoneNumber, mobileNumber, fax, email, jobTitle, department, department.id, department.name, city, departmentFree, branch, branch.id, branch.name, location, location.id, location.branch, location.branch.id, location.branch.name, location.name, location.room

Base Command#

topdesk-persons-list

Input#

Argument NameDescriptionRequired
startThe offset at which to start listing the persons at. Must be greater or equal to 0. Default is 0.Optional
page_sizeThe amount of persons to be returned per request. Must be between 1 and 100. Default is 10.Optional
queryA FIQL search expression to filter the result. (e.g., manager.name==Alice) Available from Supporting-Files-API version 1.38.0. The FIQL query syntax is documented in the TOPdesk tutorial.Optional
fieldsA comma-separated list of which fields should be included. By default all fields will be included.Optional

Context Output#

PathTypeDescription
TOPdesk.Person.IdStringPerson ID.
TOPdesk.Person.StatusStringPerson status.
TOPdesk.Person.SurNameStringPerson's surname.
TOPdesk.Person.FirstNameStringPerson's first name.
TOPdesk.Person.DynamicNameStringPerson's dynamic name (firstName SecondName).
TOPdesk.Person.FirstInitialsStringPerson's first initials.
TOPdesk.Person.PrefixesStringPerson's prefixes (e.g., DR, MR)
TOPdesk.Person.BirthNameStringPerson's birth name.
TOPdesk.Person.TitleStringPerson's title.
TOPdesk.Person.GenderStringPerson's gender.
TOPdesk.Person.Language.IdStringPerson's language ID.
TOPdesk.Person.Language.NameStringPerson's language name.
TOPdesk.Person.PhoneNumberStringPerson's phone number.
TOPdesk.Person.MobileNumberStringPerson's mobile number.
TOPdesk.Person.FaxStringPerson's fax.
TOPdesk.Person.EmailStringPerson's email.
TOPdesk.Person.JobTitleStringPerson's job title.
TOPdesk.Person.DepartmentUnknownPerson's department.
TOPdesk.Person.BudgetHolderUnknownPerson's budget holder.
TOPdesk.Person.EmployeeNumberStringPerson's employee number.
TOPdesk.Person.NetworkLoginNameStringPerson's network login name.
TOPdesk.Person.MainframeLoginNameStringPerson's mainframe login name.
TOPdesk.Person.ClientReferenceNumberStringPerson's client reference number.
TOPdesk.Person.CityStringPerson's city.
TOPdesk.Person.TasLoginNameStringPerson's tas login name.
TOPdesk.Person.ShowBranchBooleanPerson's branch visibility.
TOPdesk.Person.ShowBudgetholderBooleanPerson's budget holder visibility.
TOPdesk.Person.ShowDepartmentBooleanPerson's department visibility.
TOPdesk.Person.ShowSubsidiariesBooleanPerson's subsidiaries visibility.
TOPdesk.Person.ShowAllBranchesBooleanPerson's all branches visibility.
TOPdesk.Person.AuthorizeAllBooleanPerson authorization on everything.
TOPdesk.Person.AuthorizeDepartmentBooleanPerson authorization on department.
TOPdesk.Person.AuthorizeBudgetHolderBooleanPerson's authorization on budget holder.
TOPdesk.Person.AuthorizeBranchBooleanPerson's authorization on branch.
TOPdesk.Person.AuthorizeSubsidiaryBranchesBooleanPerson's authorization on subsidiary branches.
TOPdesk.Person.IsManagerBooleanIs the person manager.
TOPdesk.Person.ManagerUnknownPerson's manager.
TOPdesk.Person.HasAttentionBooleanDoes the person have attention.
TOPdesk.Person.AttentionUnknownPerson's attention object.
TOPdesk.Person.AttentionCommentStringPerson's attention comment.
TOPdesk.Person.Creator.IdStringPerson's creator ID.
TOPdesk.Person.Creator.NameStringPerson's creator name.
TOPdesk.Person.CreationDateDatePerson's creation date.
TOPdesk.Person.Modifier.IdStringPerson's modifier ID.
TOPdesk.Person.Modifier.NameStringPerson's modifier name.
TOPdesk.Person.ModificationDateDatePerson's modification date.
TOPdesk.Person.OptionalFields1.Boolean1BooleanPerson's optional fields1 boolean1.
TOPdesk.Person.OptionalFields1.Boolean2BooleanPerson's optional fields1 boolean2.
TOPdesk.Person.OptionalFields1.Boolean3BooleanPerson's optional fields1 boolean3.
TOPdesk.Person.OptionalFields1.Boolean4BooleanPerson's optional fields1 boolean4.
TOPdesk.Person.OptionalFields1.Boolean5BooleanPerson's optional fields1 boolean5.
TOPdesk.Person.OptionalFields1.Number1NumberPerson's optional fields1 number1.
TOPdesk.Person.OptionalFields1.Number2NumberPerson's optional fields1 number2.
TOPdesk.Person.OptionalFields1.Number3NumberPerson's optional fields1 number3.
TOPdesk.Person.OptionalFields1.Number4NumberPerson's optional fields1 number4.
TOPdesk.Person.OptionalFields1.Number5NumberPerson's optional fields1 number5.
TOPdesk.Person.OptionalFields1.Date1UnknownPerson's optional fields1 date1.
TOPdesk.Person.OptionalFields1.Date2UnknownPerson's optional fields1 date2.
TOPdesk.Person.OptionalFields1.Date3UnknownPerson's optional fields1 date3.
TOPdesk.Person.OptionalFields1.Date4UnknownPerson's optional fields1 date4.
TOPdesk.Person.OptionalFields1.Date5UnknownPerson's optional fields1 date5.
TOPdesk.Person.OptionalFields1.Text1StringPerson's optional fields1 text1.
TOPdesk.Person.OptionalFields1.Text2StringPerson's optional fields1 text2.
TOPdesk.Person.OptionalFields1.Text3StringPerson's optional fields1 text3.
TOPdesk.Person.OptionalFields1.Text4StringPerson's optional fields1 text4.
TOPdesk.Person.OptionalFields1.Text5StringPerson's optional fields1 text5.
TOPdesk.Person.OptionalFields1.Memo1UnknownPerson's optional fields1 memo1.
TOPdesk.Person.OptionalFields1.Memo2UnknownPerson's optional fields1 memo2.
TOPdesk.Person.OptionalFields1.Memo3UnknownPerson's optional fields1 memo3.
TOPdesk.Person.OptionalFields1.Memo4UnknownPerson's optional fields1 memo4.
TOPdesk.Person.OptionalFields1.Memo5UnknownPerson's optional fields1 memo5.
TOPdesk.Person.OptionalFields1.Searchlist1UnknownPerson's optional fields1 searchlist1.
TOPdesk.Person.OptionalFields1.Searchlist2UnknownPerson's optional fields1 searchlist2.
TOPdesk.Person.OptionalFields1.Searchlist3UnknownPerson's optional fields1 searchlist3.
TOPdesk.Person.OptionalFields1.Searchlist4UnknownPerson's optional fields1 searchlist4.
TOPdesk.Person.OptionalFields1.Searchlist5UnknownPerson's optional fields1 searchlist5.
TOPdesk.Person.OptionalFields2.Boolean1BooleanPerson's optional fields2 boolean1.
TOPdesk.Person.OptionalFields2.Boolean2BooleanPerson's optional fields2 boolean2.
TOPdesk.Person.OptionalFields2.Boolean3BooleanPerson's optional fields2 boolean3.
TOPdesk.Person.OptionalFields2.Boolean4BooleanPerson's optional fields2 boolean4.
TOPdesk.Person.OptionalFields2.Boolean5BooleanPerson's optional fields2 boolean5.
TOPdesk.Person.OptionalFields2.Number1NumberPerson's optional fields2 number1.
TOPdesk.Person.OptionalFields2.Number2NumberPerson's optional fields2 number2.
TOPdesk.Person.OptionalFields2.Number3NumberPerson's optional fields2 number3.
TOPdesk.Person.OptionalFields2.Number4NumberPerson's optional fields2 number4.
TOPdesk.Person.OptionalFields2.Number5NumberPerson's optional fields2 number5.
TOPdesk.Person.OptionalFields2.Date1UnknownPerson's optional fields2 date1.
TOPdesk.Person.OptionalFields2.Date2UnknownPerson's optional fields2 date2.
TOPdesk.Person.OptionalFields2.Date3UnknownPerson's optional fields2 date3.
TOPdesk.Person.OptionalFields2.Date4UnknownPerson's optional fields2 date4.
TOPdesk.Person.OptionalFields2.Date5UnknownPerson's optional fields2 date5.
TOPdesk.Person.OptionalFields2.Text1StringPerson's optional fields2 text1.
TOPdesk.Person.OptionalFields2.Text2StringPerson's optional fields2 text2.
TOPdesk.Person.OptionalFields2.Text3StringPerson's optional fields2 text3.
TOPdesk.Person.OptionalFields2.Text4StringPerson's optional fields2 text4.
TOPdesk.Person.OptionalFields2.Text5StringPerson's optional fields2 text5.
TOPdesk.Person.OptionalFields2.Memo1UnknownPerson's optional fields2 memo1.
TOPdesk.Person.OptionalFields2.Memo2UnknownPerson's optional fields2 memo2.
TOPdesk.Person.OptionalFields2.Memo3UnknownPerson's optional fields2 memo3.
TOPdesk.Person.OptionalFields2.Memo4UnknownPerson's optional fields2 memo4.
TOPdesk.Person.OptionalFields2.Memo5UnknownPerson's optional fields2 memo5.
TOPdesk.Person.OptionalFields2.Searchlist1UnknownPerson's optional fields2 searchlist1.
TOPdesk.Person.OptionalFields2.Searchlist2UnknownPerson's optional fields2 searchlist2.
TOPdesk.Person.OptionalFields2.Searchlist3UnknownPerson's optional fields2 searchlist3.
TOPdesk.Person.OptionalFields2.Searchlist4UnknownPerson's optional fields2 searchlist4.
TOPdesk.Person.OptionalFields2.Searchlist5UnknownPerson's optional fields2 searchlist5.
TOPdesk.Person.PersonExtraFieldAUnknownPerson's extra field A.
TOPdesk.Person.PersonExtraFieldBUnknownPerson's extra field B.
TOPdesk.Person.DepartmentFreeUnknownPerson's department free.
TOPdesk.Person.Branch.IdStringPerson's branch ID.
TOPdesk.Person.Branch.NameStringPerson's branch name.
TOPdesk.Person.Branch.ClientReferenceNumberStringPerson's branch client reference number.
TOPdesk.Person.Branch.TimeZoneStringPerson's branch timezone.
TOPdesk.Person.Branch.ExtraA.IdStringPerson's branch extra A ID.
TOPdesk.Person.Branch.ExtraA.NameStringPerson's branch extra A name.
TOPdesk.Person.Branch.ExtraBUnknownPerson's branch extra B.
TOPdesk.Person.Branch.ExtraB.IdStringPerson's branch extra B ID.
TOPdesk.Person.Branch.ExtraB.NameStringPerson's branch extra B name.
TOPdesk.Person.LocationUnknownPerson's location.

Command Example#

!topdesk-persons-list

Context Example#

{
"TOPdesk": {
"Person": [
{
"AttentionComment": "",
"AuthorizeAll": false,
"AuthorizeBranch": false,
"AuthorizeBudgetHolder": false,
"AuthorizeDepartment": false,
"AuthorizeSubsidiaryBranches": false,
"BirthName": "",
"Branch": {
"ClientReferenceNumber": "1337",
"ExtraA": {
"Id": "some-extra-id",
"Name": "Building in progress"
},
"Id": "some-branch-id-1",
"Name": "HQ",
"TimeZone": ""
},
"City": "",
"ClientReferenceNumber": "1337",
"CreationDate": "2020-12-21T09:16:34.000+0000",
"Creator": {
"Id": "some-admin-id",
"Name": "TOPdesk Admin"
},
"DynamicName": "Xsoar - User - A",
"Email": "",
"EmployeeNumber": "",
"Fax": "",
"FirstInitials": "",
"FirstName": "Xsoar -",
"Gender": "UNDEFINED",
"HasAttention": false,
"Id": "some-user-id-a",
"IsManager": false,
"JobTitle": "",
"Language": {
"Id": "some-eng-lng-id",
"Name": "ENG"
},
"MainframeLoginName": "",
"MobileNumber": "",
"ModificationDate": "2020-12-21T09:20:53.000+0000",
"Modifier": {
"Id": "some-admin-id",
"Name": "TOPdesk Admin"
},
"NetworkLoginName": "",
"OptionalFields1": {
"Text1": "",
"Text2": "",
"Text3": "",
"Text4": "",
"Text5": ""
},
"OptionalFields2": {
"Text1": "",
"Text2": "",
"Text3": "",
"Text4": "",
"Text5": ""
},
"PhoneNumber": "",
"Prefixes": "",
"ShowAllBranches": false,
"ShowBranch": true,
"ShowBudgetholder": false,
"ShowDepartment": false,
"ShowSubsidiaries": false,
"Status": "person",
"SurName": "User - A",
"TasLoginName": "xsoar-user-a",
"Title": ""
}
]
}
}

Human Readable Output#

TOPdesk persons#

IdNameBranchName
some-user-id-aXsoar - User - AXSoar - Customer - A
some-user-id-bXsoar - User - BXsoar - Customer - B

topdesk-operators-list#

Get list of operators.

Permissions#

Operator: With read permission on operators; Branch/Operator filters apply

Person: No access

Base Command#

topdesk-operators-list

Input#

Argument NameDescriptionRequired
startThe offset at which to start listing the operators at. Must be greater or equal to 0. Default is 0.Optional
page_sizeThe amount of operators to be returned per request. Must be between 1 and 100. Default is 10.Optional
queryA FIQL search expression to filter the result. (e.g., manager.name==Alice) Available from Supporting-Files-API version 1.38.0. The FIQL query syntax is documented in the TOPdesk tutorial.Optional

Context Output#

PathTypeDescription
TOPdesk.Operator.IdStringOperator's ID.
TOPdesk.Operator.PrincipalIdStringOperator's principal ID.
TOPdesk.Operator.StatusStringOperator's status.
TOPdesk.Operator.SurNameStringOperator's surname.
TOPdesk.Operator.FirstNameStringOperator's first name.
TOPdesk.Operator.DynamicNameStringOperator's dynamic name.
TOPdesk.Operator.InitialsStringOperator's initials.
TOPdesk.Operator.PrefixesStringOperator's prefixes.
TOPdesk.Operator.BirthNameStringOperator's birth name.
TOPdesk.Operator.TitleStringOperator's title.
TOPdesk.Operator.GenderStringOperator's gender.
TOPdesk.Operator.Language.IdStringOperator's language ID.
TOPdesk.Operator.Language.NameStringOperator's language name.
TOPdesk.Operator.Branch.IdStringOperator's branch ID.
TOPdesk.Operator.Branch.NameStringOperator's branch name.
TOPdesk.Operator.Branch.ClientReferenceNumberStringOperator's Branch Client reference number.
TOPdesk.Operator.Branch.TimeZoneStringOperator's branch timezone.
TOPdesk.Operator.Branch.ExtraA.IdStringOperator's branch extra A ID.
TOPdesk.Operator.Branch.ExtraA.NameStringOperator's branch extra A name.
TOPdesk.Operator.Branch.ExtraB.IdStringOperator's branch extra B ID.
TOPdesk.Operator.Branch.ExtraB.NameStringOperator's branch extra B name.
TOPdesk.Operator.LocationUnknownOperator's location.
TOPdesk.Operator.TelephoneStringOperator's telephone.
TOPdesk.Operator.MobileNumberStringOperator's mobile number.
TOPdesk.Operator.FaxNumberStringOperator's fax number.
TOPdesk.Operator.EmailStringOperator's email.
TOPdesk.Operator.ExchangeAccountStringOperator's exchange account.
TOPdesk.Operator.LoginNameStringOperator's login name.
TOPdesk.Operator.LoginPermissionBooleanOperator's login permission.
TOPdesk.Operator.JobTitleStringOperator's job title.
TOPdesk.Operator.DepartmentUnknownOperator's department.
TOPdesk.Operator.BudgetHolderUnknownOperator's budget holder.
TOPdesk.Operator.EmployeeNumberStringOperator's employee number.
TOPdesk.Operator.HourlyRateNumberOperator's hourly rate.
TOPdesk.Operator.NetworkLoginNameStringOperator's network login name.
TOPdesk.Operator.MainframeLoginNameStringOperator's mainframe login name.
TOPdesk.Operator.HasAttentionBooleanOperator's has attention.
TOPdesk.Operator.AttentionUnknownOperator's attention.
TOPdesk.Operator.CommentsStringOperator's comments.
TOPdesk.Operator.InstallerBooleanOperator's installer.
TOPdesk.Operator.FirstLineCallOperatorBooleanOperator's first line call operator.
TOPdesk.Operator.SecondLineCallOperatorBooleanOperator's second line call operator.
TOPdesk.Operator.ProblemManagerBooleanOperator's problem manager.
TOPdesk.Operator.ProblemOperatorBooleanOperator's problem operator.
TOPdesk.Operator.ChangeCoordinatorBooleanOperator's change coordinator.
TOPdesk.Operator.ChangeActivitiesOperatorBooleanOperator's change activities operator.
TOPdesk.Operator.RequestForChangeOperatorBooleanOperator's request for change operator.
TOPdesk.Operator.ExtensiveChangeOperatorBooleanOperator's extensive change operator.
TOPdesk.Operator.SimpleChangeOperatorBooleanOperator's simple change operator.
TOPdesk.Operator.ScenarioManagerBooleanOperator's scenario manager.
TOPdesk.Operator.PlanningActivityManagerBooleanOperator's planning activity manager.
TOPdesk.Operator.ProjectCoordinatorBooleanOperator's project coordinator.
TOPdesk.Operator.ProjectActiviesOperatorBooleanOperator's project activities operator.
TOPdesk.Operator.StockManagerBooleanOperator's stock manager.
TOPdesk.Operator.ReservationsOperatorBooleanOperator's reservations operator.
TOPdesk.Operator.ServiceOperatorBooleanOperator's service operator.
TOPdesk.Operator.ExternalHelpDeskPartyBooleanOperator's external help desk party.
TOPdesk.Operator.ContractManagerBooleanOperator's contract manager.
TOPdesk.Operator.OperationsOperatorBooleanOperator's operations operator.
TOPdesk.Operator.OperationsManagerBooleanOperator's operations manager.
TOPdesk.Operator.KnowledgeBaseManagerBooleanOperator's knowledge base manager.
TOPdesk.Operator.AccountManagerBooleanOperator's account manager.
TOPdesk.Operator.CreationDateDateOperator's creation date.
TOPdesk.Operator.Creator.IdStringOperator's creator ID.
TOPdesk.Operator.Creator.NameStringOperator's creator name.
TOPdesk.Operator.ModificationDateDateOperator's modification date.
TOPdesk.Operator.Modifier.IdStringOperator's modifier ID.
TOPdesk.Operator.Modifier.NameStringOperator's modifier name.
TOPdesk.Operator.OptionalFields1.Boolean1BooleanOperator's optional fields1 boolean1.
TOPdesk.Operator.OptionalFields1.Boolean2BooleanOperator's optional fields1 boolean2.
TOPdesk.Operator.OptionalFields1.Boolean3BooleanOperator's optional fields1 boolean3.
TOPdesk.Operator.OptionalFields1.Boolean4BooleanOperator's optional fields1 boolean4.
TOPdesk.Operator.OptionalFields1.Boolean5BooleanOperator's optional fields1 boolean5.
TOPdesk.Operator.OptionalFields1.Number1NumberOperator's optional fields1 number1.
TOPdesk.Operator.OptionalFields1.Number2NumberOperator's optional fields1 number2.
TOPdesk.Operator.OptionalFields1.Number3NumberOperator's optional fields1 number3.
TOPdesk.Operator.OptionalFields1.Number4NumberOperator's optional fields1 number4.
TOPdesk.Operator.OptionalFields1.Number5NumberOperator's optional fields1 number5.
TOPdesk.Operator.OptionalFields1.Date1UnknownOperator's optional fields1 date1.
TOPdesk.Operator.OptionalFields1.Date2UnknownOperator's optional fields1 date2.
TOPdesk.Operator.OptionalFields1.Date3UnknownOperator's optional fields1 date3.
TOPdesk.Operator.OptionalFields1.Date4UnknownOperator's optional fields1 date4.
TOPdesk.Operator.OptionalFields1.Date5UnknownOperator's optional fields1 date5.
TOPdesk.Operator.OptionalFields1.Text1StringOperator's optional fields1 text1.
TOPdesk.Operator.OptionalFields1.Text2StringOperator's optional fields1 text2.
TOPdesk.Operator.OptionalFields1.Text3StringOperator's optional fields1 text3.
TOPdesk.Operator.OptionalFields1.Text4StringOperator's optional fields1 text4.
TOPdesk.Operator.OptionalFields1.Text5StringOperator's optional fields1 text5.
TOPdesk.Operator.OptionalFields1.Memo1UnknownOperator's optional fields1 memo1.
TOPdesk.Operator.OptionalFields1.Memo2UnknownOperator's optional fields1 memo2.
TOPdesk.Operator.OptionalFields1.Memo3UnknownOperator's optional fields1 memo3.
TOPdesk.Operator.OptionalFields1.Memo4UnknownOperator's optional fields1 memo4.
TOPdesk.Operator.OptionalFields1.Memo5UnknownOperator's optional fields1 memo5.
TOPdesk.Operator.OptionalFields1.Searchlist1UnknownOperator's optional fields1 searchlist1.
TOPdesk.Operator.OptionalFields1.Searchlist2UnknownOperator's optional fields1 searchlist2.
TOPdesk.Operator.OptionalFields1.Searchlist3UnknownOperator's optional fields1 searchlist3.
TOPdesk.Operator.OptionalFields1.Searchlist4UnknownOperator's optional fields1 searchlist4.
TOPdesk.Operator.OptionalFields1.Searchlist5UnknownOperator's optional fields1 searchlist5.
TOPdesk.Operator.OptionalFields2.Boolean1BooleanOperator's optional fields2 boolean1.
TOPdesk.Operator.OptionalFields2.Boolean2BooleanOperator's optional fields2 boolean2.
TOPdesk.Operator.OptionalFields2.Boolean3BooleanOperator's optional fields2 boolean3.
TOPdesk.Operator.OptionalFields2.Boolean4BooleanOperator's optional fields2 boolean4.
TOPdesk.Operator.OptionalFields2.Boolean5BooleanOperator's optional fields2 boolean5.
TOPdesk.Operator.OptionalFields2.Number1NumberOperator's optional fields2 number1.
TOPdesk.Operator.OptionalFields2.Number2NumberOperator's optional fields2 number2.
TOPdesk.Operator.OptionalFields2.Number3NumberOperator's optional fields2 number3.
TOPdesk.Operator.OptionalFields2.Number4NumberOperator's optional fields2 number4.
TOPdesk.Operator.OptionalFields2.Number5NumberOperator's optional fields2 number5.
TOPdesk.Operator.OptionalFields2.Date1UnknownOperator's optional fields2 date1.
TOPdesk.Operator.OptionalFields2.Date2UnknownOperator's optional fields2 date2.
TOPdesk.Operator.OptionalFields2.Date3UnknownOperator's optional fields2 date3.
TOPdesk.Operator.OptionalFields2.Date4UnknownOperator's optional fields2 date4.
TOPdesk.Operator.OptionalFields2.Date5UnknownOperator's optional fields2 date5.
TOPdesk.Operator.OptionalFields2.Text1StringOperator's optional fields2 text1.
TOPdesk.Operator.OptionalFields2.Text2StringOperator's optional fields2 text2.
TOPdesk.Operator.OptionalFields2.Text3StringOperator's optional fields2 text3.
TOPdesk.Operator.OptionalFields2.Text4StringOperator's optional fields2 text4.
TOPdesk.Operator.OptionalFields2.Text5StringOperator's optional fields2 text5.
TOPdesk.Operator.OptionalFields2.Memo1UnknownOperator's optional fields2 memo1.
TOPdesk.Operator.OptionalFields2.Memo2UnknownOperator's optional fields2 memo2.
TOPdesk.Operator.OptionalFields2.Memo3UnknownOperator's optional fields2 memo3.
TOPdesk.Operator.OptionalFields2.Memo4UnknownOperator's optional fields2 memo4.
TOPdesk.Operator.OptionalFields2.Memo5UnknownOperator's optional fields2 memo5.
TOPdesk.Operator.OptionalFields2.Searchlist1UnknownOperator's optional fields2 searchlist1.
TOPdesk.Operator.OptionalFields2.Searchlist2UnknownOperator's optional fields2 searchlist2.
TOPdesk.Operator.OptionalFields2.Searchlist3UnknownOperator's optional fields2 searchlist3.
TOPdesk.Operator.OptionalFields2.Searchlist4UnknownOperator's optional fields2 searchlist4.
TOPdesk.Operator.OptionalFields2.Searchlist5UnknownOperator's optional fields2 searchlist5.

Command Example#

!topdesk-operators-list

Context Example#

{
"TOPdesk": {
"Operator": {
"AccountManager": false,
"BirthName": "",
"Branch": {
"ClientReferenceNumber": "1337",
"ExtraA": {
"Id": "some-extra-id",
"Name": "Building in progress"
},
"Id": "some-branch-id-1",
"Name": "HQ",
"TimeZone": ""
},
"ChangeActivitiesOperator": false,
"ChangeCoordinator": false,
"Comments": "",
"ContractManager": false,
"CreationDate": "2020-12-21T09:24:35.000+0000",
"Creator": {
"Id": "some-admin-id",
"Name": "TOPdesk Admin"
},
"DynamicName": "Xsoar - Operator",
"Email": "xsoar-dev@example.com",
"EmployeeNumber": "",
"ExchangeAccount": "xsoar-dev@example.com",
"ExtensiveChangeOperator": false,
"ExternalHelpDeskParty": false,
"FaxNumber": "",
"FirstLineCallOperator": true,
"FirstName": "Xsoar -",
"Gender": "UNDEFINED",
"HasAttention": false,
"Id": "some-operator-id",
"Initials": "",
"Installer": false,
"JobTitle": "",
"KnowledgeBaseManager": false,
"Language": {
"Id": "some-eng-lng-id",
"Name": "ENG"
},
"LoginName": "XSOAR-OPERATOR",
"LoginPermission": true,
"MainframeLoginName": "",
"MobileNumber": "",
"ModificationDate": "2020-12-21T09:24:35.000+0000",
"Modifier": {
"Id": "some-admin-id",
"Name": "TOPdesk Admin"
},
"NetworkLoginName": "",
"OperationsManager": false,
"OperationsOperator": false,
"OptionalFields1": {
"Text1": "",
"Text2": "",
"Text3": "",
"Text4": "",
"Text5": ""
},
"OptionalFields2": {
"Text1": "",
"Text2": "",
"Text3": "",
"Text4": "",
"Text5": ""
},
"PlanningActivityManager": false,
"Prefixes": "",
"PrincipalId": "some-principal-id",
"ProblemManager": false,
"ProblemOperator": false,
"ProjectActiviesOperator": false,
"ProjectCoordinator": false,
"RequestForChangeOperator": false,
"ReservationsOperator": false,
"ScenarioManager": false,
"SecondLineCallOperator": true,
"ServiceOperator": false,
"SimpleChangeOperator": false,
"Status": "operator",
"StockManager": false,
"SurName": "Operator",
"Telephone": "",
"Title": ""
}
}
}

Human Readable Output#

TOPdesk operators#

IdNameBranchName
some-operator-idXsoar - OperatorHQ

topdesk-branches-list#

Get list of branches.

Permissions#

Operator: Branch filters apply

Person: Only accessible when branches are editable in the SSP. Returns only ID and name.

Base Command#

topdesk-branches-list

Input#

Argument NameDescriptionRequired
startThe offset at which to start listing the persons at. Must be greater or equal to 0. Default is 0.Optional
page_sizeThe amount of persons to be returned per request. Must be between 1 and 100. Default is 10.Optional
queryA FIQL search expression to filter the result. (e.g., address.country.name=NL) Available from Supporting-Files-API version 1.38.0. The FIQL query syntax is documented in the TOPdesk tutorial.Optional
fieldsA comma-separated list of which fields should be included. By default fields ID and name will be included.Optional

Context Output#

PathTypeDescription
TOPdesk.Branch.IdStringBranch's ID.
TOPdesk.Branch.StatusStringBranch's status.
TOPdesk.Branch.NameStringBranch's name.
TOPdesk.Branch.SpecificationStringBranch's specification.
TOPdesk.Branch.ClientReferenceNumberStringBranch's client reference number.
TOPdesk.Branch.TimeZoneStringBranch's timezone.
TOPdesk.Branch.ExtraA.IdStringBranch's extra A ID.
TOPdesk.Branch.ExtraA.NameStringBranch's extra A name.
TOPdesk.Branch.ExtraB.IdStringBranch's extra B ID.
TOPdesk.Branch.ExtraB.NameStringBranch's extra B name.
TOPdesk.Branch.PhoneStringBranch's phone.
TOPdesk.Branch.FaxStringBranch's fax.
TOPdesk.Branch.Address.Country.IdStringBranch's address country ID.
TOPdesk.Branch.Address.Country.NameStringBranch's address country name.
TOPdesk.Branch.Address.StreetStringBranch's address street.
TOPdesk.Branch.Address.NumberStringBranch's address number.
TOPdesk.Branch.Address.CountyStringBranch's address county.
TOPdesk.Branch.Address.CityStringBranch's address city.
TOPdesk.Branch.Address.PostcodeStringBranch's address postcode.
TOPdesk.Branch.Address.AddressMemoStringBranch's address memo.
TOPdesk.Branch.Address.AddressTypeStringBranch's address type.
TOPdesk.Branch.EmailStringBranch's email.
TOPdesk.Branch.WebsiteStringBranch's website.
TOPdesk.Branch.PostalAddress.Country.IdStringBranch's postal address country ID.
TOPdesk.Branch.PostalAddress.Country.NameStringBranch's postal address country name.
TOPdesk.Branch.PostalAddress.StreetStringBranch's postal address street.
TOPdesk.Branch.PostalAddress.NumberStringBranch's postal address number.
TOPdesk.Branch.PostalAddress.CountyStringBranch's postal address county.
TOPdesk.Branch.PostalAddress.CityStringBranch's postal address city.
TOPdesk.Branch.PostalAddress.PostcodeStringBranch's postal address postcode.
TOPdesk.Branch.PostalAddress.AddressMemoStringBranch's postal address memo.
TOPdesk.Branch.PostalAddress.AddressTypeStringBranch's postal address type.
TOPdesk.Branch.BranchTypeStringBranch's branch type.
TOPdesk.Branch.HeadBranch.IdStringBranch's head branch ID.
TOPdesk.Branch.HeadBranch.NameStringBranch's head branch name.
TOPdesk.Branch.MembershipNumberStringBranch's membership number.
TOPdesk.Branch.AccountManager.IdStringBranch's account manager ID.
TOPdesk.Branch.AccountManager.NameStringBranch's account manager name.
TOPdesk.Branch.Contact.IdStringBranch's contact ID.
TOPdesk.Branch.Contact.NameStringBranch's contact name.
TOPdesk.Branch.VatNumberStringBranch's VAT number.
TOPdesk.Branch.SurfaceAreaNumberBranch's surface area.
TOPdesk.Branch.VolumeNumberBranch's volume.
TOPdesk.Branch.Attention.IdStringBranch's attention ID.
TOPdesk.Branch.Attention.NameStringBranch's attention name.
TOPdesk.Branch.AttentionCommentStringBranch's attention comment.
TOPdesk.Branch.AdditionalInfoStringBranch's additional info.
TOPdesk.Branch.ServiceWindowOptionStringBranch's service window option.
TOPdesk.Branch.ServiceWindow.IdStringBranch's service window ID.
TOPdesk.Branch.ServiceWindow.NameStringBranch's service window name window name.
TOPdesk.Branch.RealEstate.RegistryReferenceStringBranch's real estate registry reference.
TOPdesk.Branch.RealEstate.OwnerNameStringBranch's real estate owner name.
TOPdesk.Branch.RealEstate.OwnerMobileStringBranch's real estate owner mobile.
TOPdesk.Branch.RealEstate.OwnerTelephoneStringBranch's real estate owner telephone.
TOPdesk.Branch.RealEstate.OwnerEmailStringBranch's real estate owner email.
TOPdesk.Branch.RealEstate.DesignatedUse.IdStringBranch's real estate designated use ID.
TOPdesk.Branch.RealEstate.DesignatedUse.NameStringBranch's real estate designated use name.
TOPdesk.Branch.RealEstate.ListedBuilding.IdStringBranch's real estate listed building ID.
TOPdesk.Branch.RealEstate.ListedBuilding.NameStringBranch's real estate listed building name.
TOPdesk.Branch.RealEstate.ConstructionYearNumberBranch's real estate construction year.
TOPdesk.Branch.RealEstate.AcquisitionYearNumberBranch's real estate acquisition year.
TOPdesk.Branch.RealEstate.AcquisitionPriceNumberBranch's real estate acquisition price.
TOPdesk.Branch.RealEstate.EnergyPerformance.IdStringBranch's real estate energy performance ID.
TOPdesk.Branch.RealEstate.EnergyPerformance.NameStringBranch's real estate energy performance name.
TOPdesk.Branch.RealEstate.EnergyPerformanceMeasurementDateDateBranch's real estate energy performance measurement date.
TOPdesk.Branch.RealEstate.EnvironmentalImpact.IdStringBranch's real estate environmental impact ID.
TOPdesk.Branch.RealEstate.EnvironmentalImpact.NameStringBranch's real estate environmental impact name.
TOPdesk.Branch.RealEstate.EnvironmentalImpactMeasurementDateDateBranch's real estate environmental impact measurement date.
TOPdesk.Branch.RealEstate.BuildingLevelEPC.IdStringBranch's real estate building level EPC ID.
TOPdesk.Branch.RealEstate.BuildingLevelEPC.NameStringBranch's real estate building level EPC name.
TOPdesk.Branch.RealEstate.TotalAcquisitionCostNumberBranch's real estate total acquisition cost.
TOPdesk.Branch.RealEstate.PropertyValuationNumberBranch's real estate property valuation.
TOPdesk.Branch.RealEstate.ResidualValueNumberBranch's real estate residual value.
TOPdesk.Branch.RealEstate.AnnualDepreciationNumberBranch's real estate annual depreciation.
TOPdesk.Branch.RealEstate.DepreciationPeriodNumberBranch's real estate depreciation period.
TOPdesk.Branch.RealEstate.LiquidationValueNumberBranch's real estate liquidation value.
TOPdesk.Branch.RealEstate.LiquidationValueSurveyDateDateBranch's real estate liquidation value survey date.
TOPdesk.Branch.RealEstate.LandValueNumberBranch's real estate land value.
TOPdesk.Branch.RealEstate.LandValueSurveyDateDateBranch's real estate land value survey date.
TOPdesk.Branch.RealEstate.MarketValueNumberBranch's real estate market value.
TOPdesk.Branch.RealEstate.MarketValueSurveyDateDateBranch's real estate market value survey date.
TOPdesk.Branch.RealEstate.RentalValueNumberBranch's real estate rental value.
TOPdesk.Branch.RealEstate.RentalValueSurveyDateDateBranch's real estate rental value survey date.
TOPdesk.Branch.RealEstate.RebuildingValueNumberBranch's real estate rebuilding value.
TOPdesk.Branch.RealEstate.RebuildingValueSurveyDateDateBranch's real estate rebuilding value survey date.
TOPdesk.Branch.OptionalFields1.Boolean1BooleanBranch's optional fields1 boolean1.
TOPdesk.Branch.OptionalFields1.Boolean2BooleanBranch's optional fields1 boolean2.
TOPdesk.Branch.OptionalFields1.Boolean3BooleanBranch's optional fields1 boolean3.
TOPdesk.Branch.OptionalFields1.Boolean4BooleanBranch's optional fields1 boolean4.
TOPdesk.Branch.OptionalFields1.Boolean5BooleanBranch's optional fields1 boolean5.
TOPdesk.Branch.OptionalFields1.Number1NumberBranch's optional fields1 number1.
TOPdesk.Branch.OptionalFields1.Number2NumberBranch's optional fields1 number2.
TOPdesk.Branch.OptionalFields1.Number3NumberBranch's optional fields1 number3.
TOPdesk.Branch.OptionalFields1.Number4NumberBranch's optional fields1 number4.
TOPdesk.Branch.OptionalFields1.Number5NumberBranch's optional fields1 number5.
TOPdesk.Branch.OptionalFields1.Date1DateBranch's optional fields1 date1.
TOPdesk.Branch.OptionalFields1.Date2DateBranch's optional fields1 date2.
TOPdesk.Branch.OptionalFields1.Date3DateBranch's optional fields1 date3.
TOPdesk.Branch.OptionalFields1.Date4DateBranch's optional fields1 date4.
TOPdesk.Branch.OptionalFields1.Date5DateBranch's optional fields1 date5.
TOPdesk.Branch.OptionalFields1.Text1StringBranch's optional fields1 text1.
TOPdesk.Branch.OptionalFields1.Text2StringBranch's optional fields1 text2.
TOPdesk.Branch.OptionalFields1.Text3StringBranch's optional fields1 text3.
TOPdesk.Branch.OptionalFields1.Text4StringBranch's optional fields1 text4.
TOPdesk.Branch.OptionalFields1.Text5StringBranch's optional fields1 text5.
TOPdesk.Branch.OptionalFields1.Memo1StringBranch's optional fields1 memo1.
TOPdesk.Branch.OptionalFields1.Memo2StringBranch's optional fields1 memo2.
TOPdesk.Branch.OptionalFields1.Memo3StringBranch's optional fields1 memo3.
TOPdesk.Branch.OptionalFields1.Memo4StringBranch's optional fields1 memo4.
TOPdesk.Branch.OptionalFields1.Memo5StringBranch's optional fields1 memo5.
TOPdesk.Branch.OptionalFields1.Searchlist1.IdStringBranch's optional fields1 searchlist1 ID.
TOPdesk.Branch.OptionalFields1.Searchlist1.NameStringBranch's optional fields1 searchlist1 name.
TOPdesk.Branch.OptionalFields1.Searchlist2.IdStringBranch's optional fields1 searchlist2 ID.
TOPdesk.Branch.OptionalFields1.Searchlist2.NameStringBranch's optional fields1 searchlist2 name.
TOPdesk.Branch.OptionalFields1.Searchlist3.IdStringBranch's optional fields1 searchlist3 ID.
TOPdesk.Branch.OptionalFields1.Searchlist3.NameStringBranch's optional fields1 searchlist3 name.
TOPdesk.Branch.OptionalFields1.Searchlist4.IdStringBranch's optional fields1 searchlist4 ID.
TOPdesk.Branch.OptionalFields1.Searchlist4.NameStringBranch's optional fields1 searchlist4 name.
TOPdesk.Branch.OptionalFields1.Searchlist5.IdStringBranch's optional fields1 searchlist5 ID.
TOPdesk.Branch.OptionalFields1.Searchlist5.NameStringBranch's optional fields1 searchlist5 name.
TOPdesk.Branch.OptionalFields2.Boolean1BooleanBranch's optional fields2 boolean1.
TOPdesk.Branch.OptionalFields2.Boolean2BooleanBranch's optional fields2 boolean2.
TOPdesk.Branch.OptionalFields2.Boolean3BooleanBranch's optional fields2 boolean3.
TOPdesk.Branch.OptionalFields2.Boolean4BooleanBranch's optional fields2 boolean4.
TOPdesk.Branch.OptionalFields2.Boolean5BooleanBranch's optional fields2 boolean5.
TOPdesk.Branch.OptionalFields2.Number1NumberBranch's optional fields2 number1.
TOPdesk.Branch.OptionalFields2.Number2NumberBranch's optional fields2 number2.
TOPdesk.Branch.OptionalFields2.Number3NumberBranch's optional fields2 number3.
TOPdesk.Branch.OptionalFields2.Number4NumberBranch's optional fields2 number4.
TOPdesk.Branch.OptionalFields2.Number5NumberBranch's optional fields2 number5.
TOPdesk.Branch.OptionalFields2.Date1DateBranch's optional fields2 date1.
TOPdesk.Branch.OptionalFields2.Date2DateBranch's optional fields2 date2.
TOPdesk.Branch.OptionalFields2.Date3DateBranch's optional fields2 date3.
TOPdesk.Branch.OptionalFields2.Date4DateBranch's optional fields2 date4.
TOPdesk.Branch.OptionalFields2.Date5DateBranch's optional fields2 date5.
TOPdesk.Branch.OptionalFields2.Text1StringBranch's optional fields2 text1.
TOPdesk.Branch.OptionalFields2.Text2StringBranch's optional fields2 text2.
TOPdesk.Branch.OptionalFields2.Text3StringBranch's optional fields2 text3.
TOPdesk.Branch.OptionalFields2.Text4StringBranch's optional fields2 text4.
TOPdesk.Branch.OptionalFields2.Text5StringBranch's optional fields2 text5.
TOPdesk.Branch.OptionalFields2.Memo1StringBranch's optional fields2 memo1.
TOPdesk.Branch.OptionalFields2.Memo2StringBranch's optional fields2 memo2.
TOPdesk.Branch.OptionalFields2.Memo3StringBranch's optional fields2 memo3.
TOPdesk.Branch.OptionalFields2.Memo4StringBranch's optional fields2 memo4.
TOPdesk.Branch.OptionalFields2.Memo5StringBranch's optional fields2 memo5.
TOPdesk.Branch.OptionalFields2.Searchlist1.IdStringBranch's optional fields2 searchlist1 ID.
TOPdesk.Branch.OptionalFields2.Searchlist1.NameStringBranch's optional fields2 searchlist1 name.
TOPdesk.Branch.OptionalFields2.Searchlist2.IdStringBranch's optional fields2 searchlist2 ID.
TOPdesk.Branch.OptionalFields2.Searchlist2.NameStringBranch's optional fields2 searchlist2 name.
TOPdesk.Branch.OptionalFields2.Searchlist3.IdStringBranch's optional fields2 searchlist3 ID.
TOPdesk.Branch.OptionalFields2.Searchlist3.NameStringBranch's optional fields2 searchlist3 name.
TOPdesk.Branch.OptionalFields2.Searchlist4.IdStringBranch's optional fields2 searchlist4 ID.
TOPdesk.Branch.OptionalFields2.Searchlist4.NameStringBranch's optional fields2 searchlist4 name.
TOPdesk.Branch.OptionalFields2.Searchlist5.IdStringBranch's optional fields2 searchlist5 ID.
TOPdesk.Branch.OptionalFields2.Searchlist5.NameStringBranch's optional fields2 searchlist5 name.
TOPdesk.Branch.NotesStringBranch's notes.
TOPdesk.Branch.Creator.IdStringBranch's creator ID.
TOPdesk.Branch.Creator.NameStringBranch's creator name.
TOPdesk.Branch.CreationDateDateBranch's creation date.
TOPdesk.Branch.Modifier.IdStringBranch's modifier ID.
TOPdesk.Branch.Modifier.NameStringBranch's modifier name.
TOPdesk.Branch.ModificationDateDateBranch's modification date.
TOPdesk.Branch.HasAttentionBooleanBranch's has attention.

Command Example#

!topdesk-branches-list start=5

Context Example#

{
"TOPdesk": {
"Branch": [
{
"Id": "some-branch-id",
"Status": "Active",
"Name": "HeadQuarters",
"Specification": "string",
"ClientReferenceNumber": "string",
"TimeZone": "string",
"ExtraA": {
"Id": "some-id-76",
"Name": "string"
},
"ExtraB": {
"Id": "some-id-98",
"Name": "string"
},
"Phone": "1337",
"Fax": "string",
"Address": {
"Country": {
"Id": "some-id-78",
"Name": "string"
},
"Street": "Featherstone Street",
"Number": "49",
"County": "Greater London",
"City": "London",
"Postcode": "EC1Y 8SY",
"AddressMemo": "49 Featherstone Street\nLONDON\nEC1Y 8SY\nUNITED KINGDOM",
"AddressType": "GB"
},
"Email": "string",
"Website": "some-domain.com",
"PostalAddress": {
"Country": {
"Id": "some-id-56",
"Name": "string"
},
"Street": "Featherstone Street",
"Number": "49",
"County": "Greater London",
"City": "London",
"Postcode": "EC1Y 8SY",
"AddressMemo": "49 Featherstone Street\nLONDON\nEC1Y 8SY\nUNITED KINGDOM",
"AddressType": "GB"
},
"BranchType": "string",
"HeadBranch": {
"Id": "some-id-45",
"Name": "string"
},
"MembershipNumber": "string",
"AccountManager": {
"Id": "some-id-45",
"Name": "string"
},
"Contact": {
"Id": "some-id-34",
"Name": "string"
},
"VatNumber": "string",
"SurfaceArea": 0,
"Volume": 0,
"Attention": {
"Id": "some-id-23",
"Name": "string"
},
"AttentionComment": "string",
"AdditionalInfo": "string",
"ServiceWindowOption": "string",
"ServiceWindow": {
"Id": "some-id-12",
"Name": "string"
},
"RealEstate": {
"RegistryReference": "string",
"OwnerName": "string",
"OwnerMobile": "string",
"OwnerTelephone": "string",
"OwnerEmail": "string",
"DesignatedUse": {
"Id": "some-id-99",
"Name": "string"
},
"ListedBuilding": {
"Id": "some-id-88",
"Name": "string"
},
"ConstructionYear": 0,
"AcquisitionYear": 0,
"AcquisitionPrice": 0,
"EnergyPerformance": {
"Id": "some-id-77",
"Name": "string"
},
"EnergyPerformanceMeasurementDate": "2021-03-24T12:39:50.643Z",
"EnvironmentalImpact": {
"Id": "some-id-66",
"Name": "string"
},
"EnvironmentalImpactMeasurementDate": "2021-03-24T12:39:50.643Z",
"BuildingLevelEPC": {
"Id": "some-id-55",
"Name": "string"
},
"TotalAcquisitionCost": 0,
"PropertyValuation": 0,
"ResidualValue": 0,
"AnnualDepreciation": 0,
"DepreciationPeriod": 0,
"LiquidationValue": 0,
"LiquidationValueSurveyDate": "2021-03-24T12:39:50.643Z",
"LandValue": 0,
"LandValueSurveyDate": "2021-03-24T12:39:50.643Z",
"MarketValue": 0,
"MarketValueSurveyDate": "2021-03-24T12:39:50.643Z",
"RentalValue": 0,
"RentalValueSurveyDate": "2021-03-24T12:39:50.643Z",
"RebuildingValue": 0,
"RebuildingValueSurveyDate": "2021-03-24T12:39:50.643Z"
},
"OptionalFields1": {
"Boolean1": true,
"Boolean2": true,
"Boolean3": true,
"Boolean4": true,
"Boolean5": true,
"Number1": 0,
"Number2": 0,
"Number3": 0,
"Number4": 0,
"Number5": 0,
"Date1": "2021-03-24T12:39:50.643Z",
"Date2": "2021-03-24T12:39:50.643Z",
"Date3": "2021-03-24T12:39:50.643Z",
"Date4": "2021-03-24T12:39:50.643Z",
"Date5": "2021-03-24T12:39:50.643Z",
"Text1": "string",
"Text2": "string",
"Text3": "string",
"Text4": "string",
"Text5": "string",
"Memo1": "string",
"Memo2": "string",
"Memo3": "string",
"Memo4": "string",
"Memo5": "string",
"Searchlist1": {
"Id": "some-id-55",
"Name": "string"
},
"Searchlist2": {
"Id": "some-id-44",
"Name": "string"
},
"Searchlist3": {
"Id": "some-id-33",
"Name": "string"
},
"Searchlist4": {
"Id": "some-id-22",
"Name": "string"
},
"searchlist5": {
"Id": "some-id-11",
"Name": "string"
}
},
"optionalFields2": {
"Boolean1": true,
"Boolean2": true,
"Boolean3": true,
"Boolean4": true,
"Boolean5": true,
"Number1": 0,
"Number2": 0,
"Number3": 0,
"Number4": 0,
"Number5": 0,
"Date1": "2021-03-24T12:39:50.643Z",
"Date2": "2021-03-24T12:39:50.643Z",
"Date3": "2021-03-24T12:39:50.643Z",
"Date4": "2021-03-24T12:39:50.643Z",
"Date5": "2021-03-24T12:39:50.643Z",
"Text1": "string",
"Text2": "string",
"Text3": "string",
"Text4": "string",
"Text5": "string",
"Memo1": "string",
"Memo2": "string",
"Memo3": "string",
"Memo4": "string",
"Memo5": "string",
"Searchlist1": {
"Id": "some-id-6",
"Name": "string"
},
"Searchlist2": {
"Id": "some-id-5",
"Name": "string"
},
"Searchlist3": {
"Id": "some-id-4",
"Name": "string"
},
"Searchlist4": {
"Id": "some-id-3",
"Name": "string"
},
"searchlist5": {
"Id": "some-id-2",
"Name": "string"
}
},
"Notes": "string",
"Creator": {
"Id": "some-id-1",
"name": "string"
},
"CreationDate": "2021-03-24T12:39:50.644Z",
"Modifier": {
"Id": "some-id",
"Name": "string"
},
"ModificationDate": "2021-03-24T12:39:50.644Z",
"HasAttention": true
}
]
}
}

Human Readable Output#

TOPdesk branches#

IdStatusNamePhoneWebsiteAddress
some-branch-idActiveHeadQuarters1337some-domain.com49 Featherstone Street\nLONDON\nEC1Y 8SY\nUNITED KINGDOM

topdesk-incidents-list#

Get list of incidents.

Permissions#

Operator: With read permission on 1st/2nd line incident; Category/Branch/Operator filters apply

Person: Accessible; Person visibility settings apply

Base Command#

topdesk-incidents-list

Input#

Argument NameDescriptionRequired
startThe offset at which to start listing the operators at. Must be greater or equal to 0. Default is 0.Optional
page_sizeThe amount of operators to be returned per request. Must be between 1 and 100. Default is 10.Optional
queryA search expression to filter the result. The FIQL query syntax will be used if 'Use new query option' in the settings is checked, otherwise old style query will be used. The FIQL query syntax is documented in the in the TOPdesk tutorial. TOPdesk tutorial. (e.g., (FIQL) status==firsLine) (e.g., (old style) status=firsLine).Optional
incident_idThe ID of the incident to retrieve, overrides any other arguments.Optional
incident_numberThe number of the incident to retrieve, overrides any other argument but incident_id.Optional
status.Retrieve only the incidents of the given status. firstLine/secondLine/partial. Possible values are: firstLine, secondLine, partial.Optional
caller_idRetrieve only the incidents of the given caller ID.Optional
branch_idRetrieve only the incidents of the given branch ID.Optional
categoryRetrieve only the incidents of the given category. Supported only with new FIQL type queries.Optional
subcategoryRetrieve only the incidents of the given subcategory. Supported only with new FIQL type queries.Optional
call_typeRetrieve only the incidents of the given call type. Supported only with new FIQL type queries.Optional
entry_typeRetrieve only the incidents of the given entry type. Supported only with new FIQL type queries.Optional
fieldsA comma-separated list of which fields should be returned. By default all fields will be returned.Optional

Context Output#

PathTypeDescription
TOPdesk.Incident.IdStringTOPdesk incident's ID.
TOPdesk.Incident.StatusStringTOPdesk incident's status.
TOPdesk.Incident.NumberStringTOPdesk incident's number.
TOPdesk.Incident.RequestStringTOPdesk incident's request.
TOPdesk.Incident.RequestsStringTOPdesk incident's requests.
TOPdesk.Incident.ActionStringTOPdesk incident's action.
TOPdesk.Incident.AttachmentsStringTOPdesk incident's attachments.
TOPdesk.Incident.Caller.IdStringTOPdesk incident's caller ID.
TOPdesk.Incident.Caller.DynamicNameStringTOPdesk incident's caller dynamic name.
TOPdesk.Incident.Caller.Branch.ClientReferenceNumberStringTOPdesk incident's caller branch client reference number.
TOPdesk.Incident.Caller.Branch.TimeZoneStringTOPdesk incident's caller branch timezone.
TOPdesk.Incident.Caller.Branch.ExtraAUnknownTOPdesk incident's caller branch extra A.
TOPdesk.Incident.Caller.Branch.ExtraBUnknownTOPdesk incident's caller branch extra B.
TOPdesk.Incident.Caller.Branch.IdStringTOPdesk incident's caller branch ID.
TOPdesk.Incident.Caller.Branch.NameStringTOPdesk incident's caller branch name.
TOPdesk.Incident.CallerBranch.ClientReferenceNumberStringTOPdesk incident's caller branch client reference number.
TOPdesk.Incident.CallerBranch.TimeZoneStringTOPdesk incident's caller branch timezone.
TOPdesk.Incident.CallerBranch.ExtraAUnknownTOPdesk incident's caller branch extra A.
TOPdesk.Incident.CallerBranch.ExtraBUnknownTOPdesk incident's caller branch extra B.
TOPdesk.Incident.CallerBranch.IdStringTOPdesk incident's caller branch ID.
TOPdesk.Incident.CallerBranch.NameStringTOPdesk incident's caller branch name.
TOPdesk.Incident.BranchExtraFieldAUnknownTOPdesk incident's branch extra field A.
TOPdesk.Incident.BranchExtraFieldBUnknownTOPdesk incident's branch extra field B.
TOPdesk.Incident.BriefDescriptionStringTOPdesk incident's brief description.
TOPdesk.Incident.ExternalNumberStringTOPdesk incident's external number.
TOPdesk.Incident.Category.IdStringTOPdesk incident's category ID.
TOPdesk.Incident.Category.NameStringTOPdesk incident's category name.
TOPdesk.Incident.Subcategory.IdStringTOPdesk incident's subcategory ID.
TOPdesk.Incident.Subcategory.NameStringTOPdesk incident's subcategory name.
TOPdesk.Incident.CallType.IdStringTOPdesk incident's call type ID.
TOPdesk.Incident.CallType.NameStringTOPdesk incident's call type name.
TOPdesk.Incident.EntryType.IdStringTOPdesk incident's entry type ID.
TOPdesk.Incident.EntryType.NameStringTOPdesk incident's entry type name.
TOPdesk.Incident.Object.IdStringTOPdesk incident's object ID.
TOPdesk.Incident.Object.NameStringTOPdesk incident's object name.
TOPdesk.Incident.Object.Type.IdStringTOPdesk incident's object type ID.
TOPdesk.Incident.Object.Type.NameStringTOPdesk incident's object type name.
TOPdesk.Incident.Object.Make.IdStringTOPdesk incident's object make ID.
TOPdesk.Incident.Object.Make.NameStringTOPdesk incident's object make name.
TOPdesk.Incident.Object.Model.IdStringTOPdesk incident's object model ID.
TOPdesk.Incident.Object.Model.NameStringTOPdesk incident's object model name.
TOPdesk.Incident.Object.Branch.IdStringTOPdesk incident's object branch ID.
TOPdesk.Incident.Object.Branch.NameStringTOPdesk incident's object branch name.
TOPdesk.Incident.Object.Location.IdStringTOPdesk incident's object location ID.
TOPdesk.Incident.Object.Location.NameStringTOPdesk incident's object location name.
TOPdesk.Incident.Object.SpecificationStringTOPdesk incident's object specification.
TOPdesk.Incident.Object.SerialNumberStringTOPdesk incident's object serial number.
TOPdesk.Incident.Asset.IdStringTOPdesk incident's asset ID.
TOPdesk.Incident.Branch.ClientReferenceNumberStringTOPdesk incident's branch client reference number.
TOPdesk.Incident.Branch.TimeZoneStringTOPdesk incident's branch timezone.
TOPdesk.Incident.Branch.ExtraAUnknownTOPdesk incident's branch extra A.
TOPdesk.Incident.Branch.ExtraBUnknownTOPdesk incident's branch extra B.
TOPdesk.Incident.Branch.IdStringTOPdesk incident's branch ID.
TOPdesk.Incident.Branch.NameStringTOPdesk incident's branch name.
TOPdesk.Incident.Location.IdStringTOPdesk incident's location ID.
TOPdesk.Incident.Location.Branch.ClientReferenceNumberStringTOPdesk incident's location branch client reference number.
TOPdesk.Incident.Location.Branch.TimeZoneStringTOPdesk incident's location branch timezone.
TOPdesk.Incident.Location.Branch.ExtraAUnknownTOPdesk incident's location branch extra A.
TOPdesk.Incident.Location.Branch.ExtraBUnknownTOPdesk incident's location branch extra B.
TOPdesk.Incident.Location.Branch.IdStringTOPdesk incident's location branch ID.
TOPdesk.Incident.Location.Branch.NameStringTOPdesk incident's location branch name.
TOPdesk.Incident.Location.NameStringTOPdesk incident's location name.
TOPdesk.Incident.Location.RoomStringTOPdesk incident's location room.
TOPdesk.Incident.Impact.IdStringTOPdesk incident's impact ID.
TOPdesk.Incident.Impact.NameStringTOPdesk incident's impact name.
TOPdesk.Incident.Urgency.IdStringTOPdesk incident's urgency ID.
TOPdesk.Incident.Urgency.NameStringTOPdesk incident's urgency name.
TOPdesk.Incident.Priority.IdStringTOPdesk incident's priority ID.
TOPdesk.Incident.Priority.NameStringTOPdesk incident's priority name.
TOPdesk.Incident.Duration.IdStringTOPdesk incident's duration ID.
TOPdesk.Incident.Duration.NameStringTOPdesk incident's duration name.
TOPdesk.Incident.TargetDateDateTOPdesk incident's target date.
TOPdesk.Incident.Sla.IdStringTOPdesk incident's sla ID.
TOPdesk.Incident.OnHoldBooleanTOPdesk incident's on hold.
TOPdesk.Incident.OnHoldDateUnknownTOPdesk incident's on hold date.
TOPdesk.Incident.OnHoldDurationNumberTOPdesk incident's on hold duration.
TOPdesk.Incident.FeedbackMessageUnknownTOPdesk incident's feedback message.
TOPdesk.Incident.FeedbackRatingUnknownTOPdesk incident's feedback rating.
TOPdesk.Incident.Operator.IdStringTOPdesk incident's operator ID.
TOPdesk.Incident.Operator.StatusStringTOPdesk incident's operator status.
TOPdesk.Incident.Operator.NameStringTOPdesk incident's operator name.
TOPdesk.Incident.OperatorGroup.IdStringTOPdesk incident's operator group ID.
TOPdesk.Incident.OperatorGroup.NameStringTOPdesk incident's operator group name.
TOPdesk.Incident.Supplier.IdStringTOPdesk incident's supplier ID.
TOPdesk.Incident.Supplier.NameStringTOPdesk incident's supplier name.
TOPdesk.Incident.Supplier.ForFirstLineBooleanTOPdesk incident's supplier for first line.
TOPdesk.Incident.Supplier.ForSecondLineBooleanTOPdesk incident's supplier for second line.
TOPdesk.Incident.ProcessingStatus.IdStringTOPdesk incident's processing status ID.
TOPdesk.Incident.ProcessingStatus.NameStringTOPdesk incident's processing status name.
TOPdesk.Incident.CompletedBooleanTOPdesk incident's completed.
TOPdesk.Incident.CompletedDateUnknownTOPdesk incident's completed date.
TOPdesk.Incident.ClosedBooleanTOPdesk incident's closed.
TOPdesk.Incident.ClosedDateUnknownTOPdesk incident's closed date.
TOPdesk.Incident.ClosureCode.IdStringTOPdesk incident's closure code ID.
TOPdesk.Incident.ClosureCode.NameStringTOPdesk incident's closure code name.
TOPdesk.Incident.TimeSpentNumberTOPdesk incident's time spent.
TOPdesk.Incident.TimeSpentFirstLineNumberTOPdesk incident's time spent first line
TOPdesk.Incident.TimeSpentSecondLineAndPartialsNumberTOPdesk incident's time spent second line and partials.
TOPdesk.Incident.CostsNumberTOPdesk incident's costs.
TOPdesk.Incident.EscalationStatusStringTOPdesk incident's escalation status.
TOPdesk.Incident.EscalationReason.IdStringTOPdesk incident's escalation reason ID.
TOPdesk.Incident.EscalationReason.NameStringTOPdesk incident's escalation reason name.
TOPdesk.Incident.EscalationOperator.IdStringTOPdesk incident's escalation operator ID.
TOPdesk.Incident.EscalationOperator.NameStringTOPdesk incident's escalation operator name.
TOPdesk.Incident.CallDateDateTOPdesk incident's call date.
TOPdesk.Incident.Creator.IdStringTOPdesk incident's creator ID.
TOPdesk.Incident.Creator.NameStringTOPdesk incident's creator name.
TOPdesk.Incident.CreationDateDateTOPdesk incident's creation date.
TOPdesk.Incident.Modifier.IdStringTOPdesk incident's modifier ID.
TOPdesk.Incident.Modifier.NameStringTOPdesk incident's modifier name.
TOPdesk.Incident.ModificationDateDateTOPdesk incident's modification date.
TOPdesk.Incident.MajorCallBooleanTOPdesk incident's major call.
TOPdesk.Incident.MajorCallObject.NameStringTOPdesk incident's Major call object name.
TOPdesk.Incident.MajorCallObject.IdStringTOPdesk incident's major call object ID.
TOPdesk.Incident.MajorCallObject.StatusNumberTOPdesk incident's major call object status.
TOPdesk.Incident.MajorCallObject.MajorIncidentBooleanTOPdesk incident's major call object major incident.
TOPdesk.Incident.PublishToSsdBooleanTOPdesk incident's publish to SSD.
TOPdesk.Incident.MonitoredBooleanTOPdesk incident's monitored.
TOPdesk.Incident.ExpectedTimeSpentNumberTOPdesk incident's expected time spent.
TOPdesk.Incident.MainIncidentUnknownTOPdesk incident's main incident.
TOPdesk.Incident.PartialIncidents.LinkStringTOPdesk incident's partial incidents link.
TOPdesk.Incident.OptionalFields1.Boolean1BooleanTOPdesk incident's optional fields1 boolean1.
TOPdesk.Incident.OptionalFields1.Boolean2BooleanTOPdesk incident's optional fields1 boolean2.
TOPdesk.Incident.OptionalFields1.Boolean3BooleanTOPdesk incident's optional fields1 boolean3.
TOPdesk.Incident.OptionalFields1.Boolean4BooleanTOPdesk incident's optional fields1 boolean4.
TOPdesk.Incident.OptionalFields1.Boolean5BooleanTOPdesk incident's optional fields1 boolean5.
TOPdesk.Incident.OptionalFields1.Number1NumberTOPdesk incident's optional fields1 number1.
TOPdesk.Incident.OptionalFields1.Number2NumberTOPdesk incident's optional fields1 number2.
TOPdesk.Incident.OptionalFields1.Number3NumberTOPdesk incident's optional fields1 number3.
TOPdesk.Incident.OptionalFields1.Number4NumberTOPdesk incident's optional fields1 number4.
TOPdesk.Incident.OptionalFields1.Number5NumberTOPdesk incident's optional fields1 number5.
TOPdesk.Incident.OptionalFields1.Date1DateTOPdesk incident's optional fields1 date1.
TOPdesk.Incident.OptionalFields1.Date2DateTOPdesk incident's optional fields1 date2.
TOPdesk.Incident.OptionalFields1.Date3DateTOPdesk incident's optional fields1 date3.
TOPdesk.Incident.OptionalFields1.Date4DateTOPdesk incident's optional fields1 date4.
TOPdesk.Incident.OptionalFields1.Date5DateTOPdesk incident's optional fields1 date5.
TOPdesk.Incident.OptionalFields1.Text1StringTOPdesk incident's optional fields1 text1.
TOPdesk.Incident.OptionalFields1.Text2StringTOPdesk incident's optional fields1 text2.
TOPdesk.Incident.OptionalFields1.Text3StringTOPdesk incident's optional fields1 text3.
TOPdesk.Incident.OptionalFields1.Text4StringTOPdesk incident's optional fields1 text4.
TOPdesk.Incident.OptionalFields1.Text5StringTOPdesk incident's optional fields1 text5.
TOPdesk.Incident.OptionalFields1.Memo1StringTOPdesk incident's optional fields1 memo1.
TOPdesk.Incident.OptionalFields1.Memo2StringTOPdesk incident's optional fields1 memo2.
TOPdesk.Incident.OptionalFields1.Memo3StringTOPdesk incident's optional fields1 memo3.
TOPdesk.Incident.OptionalFields1.Memo4StringTOPdesk incident's optional fields1 memo4.
TOPdesk.Incident.OptionalFields1.Memo5StringTOPdesk incident's optional fields1 memo5.
TOPdesk.Incident.OptionalFields1.Searchlist1.IdStringTOPdesk incident's optional fields1 searchlist1 ID.
TOPdesk.Incident.OptionalFields1.Searchlist1.NameStringTOPdesk incident's optional fields1 searchlist1 name.
TOPdesk.Incident.OptionalFields1.Searchlist2.IdStringTOPdesk incident's optional fields1 searchlist2 ID.
TOPdesk.Incident.OptionalFields1.Searchlist2.NameStringTOPdesk incident's optional fields1 searchlist2 name.
TOPdesk.Incident.OptionalFields1.Searchlist3.IdStringTOPdesk incident's optional fields1 searchlist3 ID.
TOPdesk.Incident.OptionalFields1.Searchlist3.NameStringTOPdesk incident's optional fields1 searchlist3 name.
TOPdesk.Incident.OptionalFields1.Searchlist4.IdStringTOPdesk incident's optional fields1 searchlist4 ID.
TOPdesk.Incident.OptionalFields1.Searchlist4.NameStringTOPdesk incident's optional fields1 searchlist4 name.
TOPdesk.Incident.OptionalFields1.Searchlist5.IdStringTOPdesk incident's optional fields1 searchlist5 ID.
TOPdesk.Incident.OptionalFields1.Searchlist5.NameStringTOPdesk incident's optional fields1 searchlist5 name.
TOPdesk.Incident.OptionalFields2.Boolean1BooleanTOPdesk incident's optional fields2 boolean1.
TOPdesk.Incident.OptionalFields2.Boolean2BooleanTOPdesk incident's optional fields2 boolean2.
TOPdesk.Incident.OptionalFields2.Boolean3BooleanTOPdesk incident's optional fields2 boolean3.
TOPdesk.Incident.OptionalFields2.Boolean4BooleanTOPdesk incident's optional fields2 boolean4.
TOPdesk.Incident.OptionalFields2.Boolean5BooleanTOPdesk incident's optional fields2 boolean5.
TOPdesk.Incident.OptionalFields2.Number1NumberTOPdesk incident's optional fields2 number1.
TOPdesk.Incident.OptionalFields2.Number2NumberTOPdesk incident's optional fields2 number2.
TOPdesk.Incident.OptionalFields2.Number3NumberTOPdesk incident's optional fields2 number3.
TOPdesk.Incident.OptionalFields2.Number4NumberTOPdesk incident's optional fields2 number4.
TOPdesk.Incident.OptionalFields2.Number5NumberTOPdesk incident's optional fields2 number5.
TOPdesk.Incident.OptionalFields2.Date1DateTOPdesk incident's optional fields2 date1.
TOPdesk.Incident.OptionalFields2.Date2DateTOPdesk incident's optional fields2 date2.
TOPdesk.Incident.OptionalFields2.Date3DateTOPdesk incident's optional fields2 date3.
TOPdesk.Incident.OptionalFields2.Date4DateTOPdesk incident's optional fields2 date4.
TOPdesk.Incident.OptionalFields2.Date5DateTOPdesk incident's optional fields2 date5.
TOPdesk.Incident.OptionalFields2.Text1StringTOPdesk incident's optional fields2 text1.
TOPdesk.Incident.OptionalFields2.Text2StringTOPdesk incident's optional fields2 text2.
TOPdesk.Incident.OptionalFields2.Text3StringTOPdesk incident's OptionalFields2.Text3
TOPdesk.Incident.OptionalFields2.Text4StringTOPdesk incident's optional fields2 text4.
TOPdesk.Incident.OptionalFields2.Text5StringTOPdesk incident's optional fields2 text5.
TOPdesk.Incident.OptionalFields2.Memo1StringTOPdesk incident's optional fields2 memo1.
TOPdesk.Incident.OptionalFields2.Memo2StringTOPdesk incident's optional fields2 memo2.
TOPdesk.Incident.OptionalFields2.Memo3StringTOPdesk incident's optional fields2 memo3.
TOPdesk.Incident.OptionalFields2.Memo4StringTOPdesk incident's optional fields2 memo4.
TOPdesk.Incident.OptionalFields2.Memo5StringTOPdesk incident's optional fields2 memo5.
TOPdesk.Incident.OptionalFields2.Searchlist1.IdStringTOPdesk incident's optional fields2 searchlist1 ID.
TOPdesk.Incident.OptionalFields2.Searchlist1.NameStringTOPdesk incident's optional fields2 searchlist1 name.
TOPdesk.Incident.OptionalFields2.Searchlist2.IdStringTOPdesk incident's optional fields2 searchlist2 ID.
TOPdesk.Incident.OptionalFields2.Searchlist2.NameStringTOPdesk incident's optional fields2 searchlist2 name.
TOPdesk.Incident.OptionalFields2.Searchlist3.IdStringTOPdesk incident's optional fields2 searchlist3 ID.
TOPdesk.Incident.OptionalFields2.Searchlist3.NameStringTOPdesk incident's optional fields2 searchlist3 name.
TOPdesk.Incident.OptionalFields2.Searchlist4.IdStringTOPdesk incident's optional fields2 searchlist4 ID.
TOPdesk.Incident.OptionalFields2.Searchlist4.NameStringTOPdesk incident's optional fields2 searchlist4 name.
TOPdesk.Incident.OptionalFields2.Searchlist5.IdStringTOPdesk incident's optional fields2 searchlist5 ID.
TOPdesk.Incident.OptionalFields2.Searchlist5.NameStringTOPdesk incident's optional fields2 searchlist5 name.
TOPdesk.Incident.ExternalLinks.IdStringTOPdesk incident's external links ID.
TOPdesk.Incident.ExternalLinks.TypeStringTOPdesk incident's external links type.
TOPdesk.Incident.ExternalLinks.DateDateTOPdesk incident's external links date.

Command Example#

!topdesk-incidents-list

Context Example#

{
"TOPdesk": {
"Incident": [
{
"Action": "/tas/api/incidents/id/some-id/actions",
"Attachments": "/tas/api/incidents/id/some-id/attachments",
"BriefDescription": "",
"CallDate": "2021-03-24T08:15:13.867+0000",
"Caller": {
"DynamicName": "some-caller"
},
"Closed": false,
"Completed": false,
"CreationDate": "2021-03-24T08:15:13.867+0000",
"Creator": {
"Id": "some-id-1",
"Name": "Xsoar - Operator"
},
"ExternalNumber": "",
"Id": "some-id",
"MajorCall": false,
"ModificationDate": "2021-03-24T08:15:13.000+0000",
"Modifier": {
"Id": "some-id-1",
"Name": "Xsoar - Operator"
},
"Monitored": false,
"Number": "XSOAR-1337",
"OnHold": false,
"OptionalFields1": {
"Searchlist1": {
"Id": "some-id-3",
"Name": "Some Search Name"
},
"Searchlist3": {
"Id": "some-id-4",
"Name": "Some Other Search Name"
},
"Text1": "",
"Text2": "",
"Text3": "",
"Text4": "",
"Text5": ""
},
"OptionalFields2": {
"Text1": "",
"Text2": "",
"Text3": "",
"Text4": "",
"Text5": ""
},
"ProcessingStatus": {
"Id": "some-processing-status-id",
"Name": "Logged"
},
"PublishToSsd": false,
"Requests": "/tas/api/incidents/id/some-id/requests",
"Responded": false,
"Status": "firstLine"
}
]
}
}

Human Readable Output#

TOPdesk incidents#

IdNumberLineCallerNameStatus
some-idXSOAR-1337firstLinesome-callerLogged

topdesk-incident-actions#

List all actions for specific incident

Permissions:#

Operator: With read permission on 1st/2nd line incident; Category/Branch/Operator filters apply

Persons: Accessible; Person visibility settings apply

Base Command#

topdesk-incident-actions-list

Input#

Argument NameDescriptionRequired
incident_idThe incident ID. An ID or a number must be set. If both are set, the ID will be used.Optional
incident_numberThe incident number. An ID or a number must be set. If both are set, the ID will be used.Optional
limitThe limit for the amount of actions.Optional

Context Output#

PathTypeDescription
TOPdesk.Action.EntryDateDateDate of entry of the action
TOPdesk.Action.FlagUnknownAction's flag
TOPdesk.Action.Operator.IdStringID of the operator who created the action.
TOPdesk.Action.Operator.NameStringName of the operator who created the action.
TOPdesk.Action.InvisibleForCallerBoolIf the action is visible for person.
TOPdesk.Action.PersonStringPerson who created the action, not operator.
TOPdesk.Action.IdStringID of the action.
TOPdesk.Action.MemotextStringContent of the action.

topdesk-incident-create#

Create an incident in TOPdesk.

The command first uses the callerLookup option and tries to attach an existing user to the caller field of the incident. If the callerLookup shows up empty, the command will create an incident with an unregistered caller with a name as provided in the caller option.

Permissions:#

Operator: With create permission on 1st/2nd line incident, partials require 2nd line create permission

Person: Can only create first line incidents for himself. Only the following fields can be set depending on the setting for the new call form:

  • request
  • briefDescription
  • callType
  • category
  • subcategory
  • object
  • location
  • operatorGroup

Base Command#

topdesk-incident-create

Input#

Argument NameDescriptionRequired
callerThe caller ID for this incident. For an unregistered caller provide a name.Required
status.Status of the incident. Can only be set by operators. Possible values are: firstLine, secondLine, partial.Optional
descriptionBrief description. maximum 80 characters.Optional
requestInitial request. Can be set by operators and persons.Optional
actionInitial action. Can be set by operators and persons.Optional
action_invisible_for_callerWhether the initial action is invisible for persons. Can only be set by operators. Default value is false. Possible values are: true, false.Optional
entry_typeEntry type by name. Can only be set by operators. XSOAR is set by default for mirroring.Optional
categoryCategory by name. Can be set by operators. It is an error to provide both an ID and a name.Optional
subcategorySubcategory by name. Can be set by operators. It is an error to provide both an ID and a name.Optional
external_numberExternal number. Can only be set by operators. Max 60 characters.Optional
main_incidentMain incident ID or number, required for creating a partial incident. Can only be set by operators.Optional
additional_paramsAdditional parameters to pass when creating an incident. (e.g., {"optionalFields1":{"text1":"test"}})Optional

Context Output#

PathTypeDescription
TOPdesk.Incident.IdStringTOPdesk incident's ID.
TOPdesk.Incident.StatusStringTOPdesk incident's status.
TOPdesk.Incident.NumberStringTOPdesk incident's number.
TOPdesk.Incident.RequestStringTOPdesk incident's request.
TOPdesk.Incident.RequestsStringTOPdesk incident's requests.
TOPdesk.Incident.ActionStringTOPdesk incident's action.
TOPdesk.Incident.AttachmentsStringTOPdesk incident's attachments.
TOPdesk.Incident.Caller.IdStringTOPdesk incident's caller ID.
TOPdesk.Incident.Caller.DynamicNameStringTOPdesk incident's caller dynamic name.
TOPdesk.Incident.Caller.Branch.ClientReferenceNumberStringTOPdesk incident's caller branch client reference number.
TOPdesk.Incident.Caller.Branch.TimeZoneStringTOPdesk incident's caller branch timezone.
TOPdesk.Incident.Caller.Branch.ExtraAUnknownTOPdesk incident's caller branch extra A.
TOPdesk.Incident.Caller.Branch.ExtraBUnknownTOPdesk incident's caller branch extra B.
TOPdesk.Incident.Caller.Branch.IdStringTOPdesk incident's caller branch ID.
TOPdesk.Incident.Caller.Branch.NameStringTOPdesk incident's caller branch name.
TOPdesk.Incident.CallerBranch.ClientReferenceNumberStringTOPdesk incident's caller branch client reference number.
TOPdesk.Incident.CallerBranch.TimeZoneStringTOPdesk incident's caller branch timezone.
TOPdesk.Incident.CallerBranch.ExtraAUnknownTOPdesk incident's caller branch extra A.
TOPdesk.Incident.CallerBranch.ExtraBUnknownTOPdesk incident's caller branch extra B.
TOPdesk.Incident.CallerBranch.IdStringTOPdesk incident's caller branch ID.
TOPdesk.Incident.CallerBranch.NameStringTOPdesk incident's caller branch name.
TOPdesk.Incident.BranchExtraFieldAUnknownTOPdesk incident's branch extra field A.
TOPdesk.Incident.BranchExtraFieldBUnknownTOPdesk incident's branch extra field B.
TOPdesk.Incident.BriefDescriptionStringTOPdesk incident's brief description.
TOPdesk.Incident.ExternalNumberStringTOPdesk incident's external number.
TOPdesk.Incident.Category.IdStringTOPdesk incident's category ID.
TOPdesk.Incident.Category.NameStringTOPdesk incident's category name.
TOPdesk.Incident.Subcategory.IdStringTOPdesk incident's subcategory ID.
TOPdesk.Incident.Subcategory.NameStringTOPdesk incident's subcategory name.
TOPdesk.Incident.CallType.IdStringTOPdesk incident's call type ID.
TOPdesk.Incident.CallType.NameStringTOPdesk incident's call type name.
TOPdesk.Incident.EntryType.IdStringTOPdesk incident's entry type ID.
TOPdesk.Incident.EntryType.NameStringTOPdesk incident's entry type name.
TOPdesk.Incident.Object.IdStringTOPdesk incident's object ID.
TOPdesk.Incident.Object.NameStringTOPdesk incident's object name.
TOPdesk.Incident.Object.Type.IdStringTOPdesk incident's object type ID.
TOPdesk.Incident.Object.Type.NameStringTOPdesk incident's object type name.
TOPdesk.Incident.Object.Make.IdStringTOPdesk incident's object make ID.
TOPdesk.Incident.Object.Make.NameStringTOPdesk incident's object make name.
TOPdesk.Incident.Object.Model.IdStringTOPdesk incident's object model ID.
TOPdesk.Incident.Object.Model.NameStringTOPdesk incident's object model name.
TOPdesk.Incident.Object.Branch.IdStringTOPdesk incident's object branch ID.
TOPdesk.Incident.Object.Branch.NameStringTOPdesk incident's object branch name.
TOPdesk.Incident.Object.Location.IdStringTOPdesk incident's object location ID.
TOPdesk.Incident.Object.Location.NameStringTOPdesk incident's object location name.
TOPdesk.Incident.Object.SpecificationStringTOPdesk incident's object specification.
TOPdesk.Incident.Object.SerialNumberStringTOPdesk incident's object serial number.
TOPdesk.Incident.Asset.IdStringTOPdesk incident's asset ID.
TOPdesk.Incident.Branch.ClientReferenceNumberStringTOPdesk incident's branch client reference number.
TOPdesk.Incident.Branch.TimeZoneStringTOPdesk incident's branch timezone.
TOPdesk.Incident.Branch.ExtraAUnknownTOPdesk incident's branch extra A.
TOPdesk.Incident.Branch.ExtraBUnknownTOPdesk incident's branch extra B.
TOPdesk.Incident.Branch.IdStringTOPdesk incident's branch ID.
TOPdesk.Incident.Branch.NameStringTOPdesk incident's branch name.
TOPdesk.Incident.Location.IdStringTOPdesk incident's location ID.
TOPdesk.Incident.Location.Branch.ClientReferenceNumberStringTOPdesk incident's location branch client reference number.
TOPdesk.Incident.Location.Branch.TimeZoneStringTOPdesk incident's location branch timezone.
TOPdesk.Incident.Location.Branch.ExtraAUnknownTOPdesk incident's location branch extra A.
TOPdesk.Incident.Location.Branch.ExtraBUnknownTOPdesk incident's location branch extra B.
TOPdesk.Incident.Location.Branch.IdStringTOPdesk incident's location branch ID.
TOPdesk.Incident.Location.Branch.NameStringTOPdesk incident's location branch name.
TOPdesk.Incident.Location.NameStringTOPdesk incident's location name.
TOPdesk.Incident.Location.RoomStringTOPdesk incident's location room.
TOPdesk.Incident.Impact.IdStringTOPdesk incident's impact ID.
TOPdesk.Incident.Impact.NameStringTOPdesk incident's impact name.
TOPdesk.Incident.Urgency.IdStringTOPdesk incident's urgency ID.
TOPdesk.Incident.Urgency.NameStringTOPdesk incident's urgency name.
TOPdesk.Incident.Priority.IdStringTOPdesk incident's priority ID.
TOPdesk.Incident.Priority.NameStringTOPdesk incident's priority name.
TOPdesk.Incident.Duration.IdStringTOPdesk incident's duration ID.
TOPdesk.Incident.Duration.NameStringTOPdesk incident's duration name.
TOPdesk.Incident.TargetDateDateTOPdesk incident's target date.
TOPdesk.Incident.Sla.IdStringTOPdesk incident's sla ID.
TOPdesk.Incident.OnHoldBooleanTOPdesk incident's on hold.
TOPdesk.Incident.OnHoldDateUnknownTOPdesk incident's on hold date.
TOPdesk.Incident.OnHoldDurationNumberTOPdesk incident's on hold duration.
TOPdesk.Incident.FeedbackMessageUnknownTOPdesk incident's feedback message.
TOPdesk.Incident.FeedbackRatingUnknownTOPdesk incident's feedback rating.
TOPdesk.Incident.Operator.IdStringTOPdesk incident's operator ID.
TOPdesk.Incident.Operator.StatusStringTOPdesk incident's operator status.
TOPdesk.Incident.Operator.NameStringTOPdesk incident's operator name.
TOPdesk.Incident.OperatorGroup.IdStringTOPdesk incident's operator group ID.
TOPdesk.Incident.OperatorGroup.NameStringTOPdesk incident's operator group name.
TOPdesk.Incident.Supplier.IdStringTOPdesk incident's supplier ID.
TOPdesk.Incident.Supplier.NameStringTOPdesk incident's supplier name.
TOPdesk.Incident.Supplier.ForFirstLineBooleanTOPdesk incident's supplier for first line.
TOPdesk.Incident.Supplier.ForSecondLineBooleanTOPdesk incident's supplier for second line.
TOPdesk.Incident.ProcessingStatus.IdStringTOPdesk incident's processing status ID.
TOPdesk.Incident.ProcessingStatus.NameStringTOPdesk incident's processing status name.
TOPdesk.Incident.CompletedBooleanTOPdesk incident's completed.
TOPdesk.Incident.CompletedDateUnknownTOPdesk incident's completed date.
TOPdesk.Incident.ClosedBooleanTOPdesk incident's closed.
TOPdesk.Incident.ClosedDateUnknownTOPdesk incident's closed date.
TOPdesk.Incident.ClosureCode.IdStringTOPdesk incident's closure code ID.
TOPdesk.Incident.ClosureCode.NameStringTOPdesk incident's closure code name.
TOPdesk.Incident.TimeSpentNumberTOPdesk incident's time spent.
TOPdesk.Incident.TimeSpentFirstLineNumberTOPdesk incident's time spent first line
TOPdesk.Incident.TimeSpentSecondLineAndPartialsNumberTOPdesk incident's time spent second line and partials.
TOPdesk.Incident.CostsNumberTOPdesk incident's costs.
TOPdesk.Incident.EscalationStatusStringTOPdesk incident's escalation status.
TOPdesk.Incident.EscalationReason.IdStringTOPdesk incident's escalation reason ID.
TOPdesk.Incident.EscalationReason.NameStringTOPdesk incident's escalation reason name.
TOPdesk.Incident.EscalationOperator.IdStringTOPdesk incident's escalation operator ID.
TOPdesk.Incident.EscalationOperator.NameStringTOPdesk incident's escalation operator name.
TOPdesk.Incident.CallDateDateTOPdesk incident's call date.
TOPdesk.Incident.Creator.IdStringTOPdesk incident's creator ID.
TOPdesk.Incident.Creator.NameStringTOPdesk incident's creator name.
TOPdesk.Incident.CreationDateDateTOPdesk incident's creation date.
TOPdesk.Incident.Modifier.IdStringTOPdesk incident's modifier ID.
TOPdesk.Incident.Modifier.NameStringTOPdesk incident's modifier name.
TOPdesk.Incident.ModificationDateDateTOPdesk incident's modification date.
TOPdesk.Incident.MajorCallBooleanTOPdesk incident's major call.
TOPdesk.Incident.MajorCallObject.NameStringTOPdesk incident's Major call object name.
TOPdesk.Incident.MajorCallObject.IdStringTOPdesk incident's major call object ID.
TOPdesk.Incident.MajorCallObject.StatusNumberTOPdesk incident's major call object status.
TOPdesk.Incident.MajorCallObject.MajorIncidentBooleanTOPdesk incident's major call object major incident.
TOPdesk.Incident.PublishToSsdBooleanTOPdesk incident's publish to SSD.
TOPdesk.Incident.MonitoredBooleanTOPdesk incident's monitored.
TOPdesk.Incident.ExpectedTimeSpentNumberTOPdesk incident's expected time spent.
TOPdesk.Incident.MainIncidentUnknownTOPdesk incident's main incident.
TOPdesk.Incident.PartialIncidents.LinkStringTOPdesk incident's partial incidents link.
TOPdesk.Incident.OptionalFields1.Boolean1BooleanTOPdesk incident's optional fields1 boolean1.
TOPdesk.Incident.OptionalFields1.Boolean2BooleanTOPdesk incident's optional fields1 boolean2.
TOPdesk.Incident.OptionalFields1.Boolean3BooleanTOPdesk incident's optional fields1 boolean3.
TOPdesk.Incident.OptionalFields1.Boolean4BooleanTOPdesk incident's optional fields1 boolean4.
TOPdesk.Incident.OptionalFields1.Boolean5BooleanTOPdesk incident's optional fields1 boolean5.
TOPdesk.Incident.OptionalFields1.Number1NumberTOPdesk incident's optional fields1 number1.
TOPdesk.Incident.OptionalFields1.Number2NumberTOPdesk incident's optional fields1 number2.
TOPdesk.Incident.OptionalFields1.Number3NumberTOPdesk incident's optional fields1 number3.
TOPdesk.Incident.OptionalFields1.Number4NumberTOPdesk incident's optional fields1 number4.
TOPdesk.Incident.OptionalFields1.Number5NumberTOPdesk incident's optional fields1 number5.
TOPdesk.Incident.OptionalFields1.Date1DateTOPdesk incident's optional fields1 date1.
TOPdesk.Incident.OptionalFields1.Date2DateTOPdesk incident's optional fields1 date2.
TOPdesk.Incident.OptionalFields1.Date3DateTOPdesk incident's optional fields1 date3.
TOPdesk.Incident.OptionalFields1.Date4DateTOPdesk incident's optional fields1 date4.
TOPdesk.Incident.OptionalFields1.Date5DateTOPdesk incident's optional fields1 date5.
TOPdesk.Incident.OptionalFields1.Text1StringTOPdesk incident's optional fields1 text1.
TOPdesk.Incident.OptionalFields1.Text2StringTOPdesk incident's optional fields1 text2.
TOPdesk.Incident.OptionalFields1.Text3StringTOPdesk incident's optional fields1 text3.
TOPdesk.Incident.OptionalFields1.Text4StringTOPdesk incident's optional fields1 text4.
TOPdesk.Incident.OptionalFields1.Text5StringTOPdesk incident's optional fields1 text5.
TOPdesk.Incident.OptionalFields1.Memo1StringTOPdesk incident's optional fields1 memo1.
TOPdesk.Incident.OptionalFields1.Memo2StringTOPdesk incident's optional fields1 memo2.
TOPdesk.Incident.OptionalFields1.Memo3StringTOPdesk incident's optional fields1 memo3.
TOPdesk.Incident.OptionalFields1.Memo4StringTOPdesk incident's optional fields1 memo4.
TOPdesk.Incident.OptionalFields1.Memo5StringTOPdesk incident's optional fields1 memo5.
TOPdesk.Incident.OptionalFields1.Searchlist1.IdStringTOPdesk incident's optional fields1 searchlist1 ID.
TOPdesk.Incident.OptionalFields1.Searchlist1.NameStringTOPdesk incident's optional fields1 searchlist1 name.
TOPdesk.Incident.OptionalFields1.Searchlist2.IdStringTOPdesk incident's optional fields1 searchlist2 ID.
TOPdesk.Incident.OptionalFields1.Searchlist2.NameStringTOPdesk incident's optional fields1 searchlist2 name.
TOPdesk.Incident.OptionalFields1.Searchlist3.IdStringTOPdesk incident's optional fields1 searchlist3 ID.
TOPdesk.Incident.OptionalFields1.Searchlist3.NameStringTOPdesk incident's optional fields1 searchlist3 name.
TOPdesk.Incident.OptionalFields1.Searchlist4.IdStringTOPdesk incident's optional fields1 searchlist4 ID.
TOPdesk.Incident.OptionalFields1.Searchlist4.NameStringTOPdesk incident's optional fields1 searchlist4 name.
TOPdesk.Incident.OptionalFields1.Searchlist5.IdStringTOPdesk incident's optional fields1 searchlist5 ID.
TOPdesk.Incident.OptionalFields1.Searchlist5.NameStringTOPdesk incident's optional fields1 searchlist5 name.
TOPdesk.Incident.OptionalFields2.Boolean1BooleanTOPdesk incident's optional fields2 boolean1.
TOPdesk.Incident.OptionalFields2.Boolean2BooleanTOPdesk incident's optional fields2 boolean2.
TOPdesk.Incident.OptionalFields2.Boolean3BooleanTOPdesk incident's optional fields2 boolean3.
TOPdesk.Incident.OptionalFields2.Boolean4BooleanTOPdesk incident's optional fields2 boolean4.
TOPdesk.Incident.OptionalFields2.Boolean5BooleanTOPdesk incident's optional fields2 boolean5.
TOPdesk.Incident.OptionalFields2.Number1NumberTOPdesk incident's optional fields2 number1.
TOPdesk.Incident.OptionalFields2.Number2NumberTOPdesk incident's optional fields2 number2.
TOPdesk.Incident.OptionalFields2.Number3NumberTOPdesk incident's optional fields2 number3.
TOPdesk.Incident.OptionalFields2.Number4NumberTOPdesk incident's optional fields2 number4.
TOPdesk.Incident.OptionalFields2.Number5NumberTOPdesk incident's optional fields2 number5.
TOPdesk.Incident.OptionalFields2.Date1DateTOPdesk incident's optional fields2 date1.
TOPdesk.Incident.OptionalFields2.Date2DateTOPdesk incident's optional fields2 date2.
TOPdesk.Incident.OptionalFields2.Date3DateTOPdesk incident's optional fields2 date3.
TOPdesk.Incident.OptionalFields2.Date4DateTOPdesk incident's optional fields2 date4.
TOPdesk.Incident.OptionalFields2.Date5DateTOPdesk incident's optional fields2 date5.
TOPdesk.Incident.OptionalFields2.Text1StringTOPdesk incident's optional fields2 text1.
TOPdesk.Incident.OptionalFields2.Text2StringTOPdesk incident's optional fields2 text2.
TOPdesk.Incident.OptionalFields2.Text3StringTOPdesk incident's optional fields2.text3.
TOPdesk.Incident.OptionalFields2.Text4StringTOPdesk incident's optional fields2 text4.
TOPdesk.Incident.OptionalFields2.Text5StringTOPdesk incident's optional fields2 text5.
TOPdesk.Incident.OptionalFields2.Memo1StringTOPdesk incident's optional fields2 memo1.
TOPdesk.Incident.OptionalFields2.Memo2StringTOPdesk incident's optional fields2 memo2.
TOPdesk.Incident.OptionalFields2.Memo3StringTOPdesk incident's optional fields2 memo3.
TOPdesk.Incident.OptionalFields2.Memo4StringTOPdesk incident's optional fields2 memo4.
TOPdesk.Incident.OptionalFields2.Memo5StringTOPdesk incident's optional fields2 memo5.
TOPdesk.Incident.OptionalFields2.Searchlist1.IdStringTOPdesk incident's optional fields2 searchlist1 ID.
TOPdesk.Incident.OptionalFields2.Searchlist1.NameStringTOPdesk incident's optional fields2 searchlist1 name.
TOPdesk.Incident.OptionalFields2.Searchlist2.IdStringTOPdesk incident's optional fields2 searchlist2 ID.
TOPdesk.Incident.OptionalFields2.Searchlist2.NameStringTOPdesk incident's optional fields2 searchlist2 name.
TOPdesk.Incident.OptionalFields2.Searchlist3.IdStringTOPdesk incident's optional fields2 searchlist3 ID.
TOPdesk.Incident.OptionalFields2.Searchlist3.NameStringTOPdesk incident's optional fields2 searchlist3 name.
TOPdesk.Incident.OptionalFields2.Searchlist4.IdStringTOPdesk incident's optional fields2 searchlist4 ID.
TOPdesk.Incident.OptionalFields2.Searchlist4.NameStringTOPdesk incident's optional fields2 searchlist4 name.
TOPdesk.Incident.OptionalFields2.Searchlist5.IdStringTOPdesk incident's optional fields2 searchlist5 ID.
TOPdesk.Incident.OptionalFields2.Searchlist5.NameStringTOPdesk incident's optional fields2 searchlist5 name.
TOPdesk.Incident.ExternalLinks.IdStringTOPdesk incident's external links ID.
TOPdesk.Incident.ExternalLinks.TypeStringTOPdesk incident's external links type.
TOPdesk.Incident.ExternalLinks.DateDateTOPdesk incident's external links date.

Command Example#

!topdesk-incident-create caller=some-caller

Context Example#

{
"TOPdesk": {
"Incident": [
{
"Action": "/tas/api/incidents/id/some-id/actions",
"Attachments": "/tas/api/incidents/id/some-id/attachments",
"BriefDescription": "",
"CallDate": "2021-03-24T08:15:13.867+0000",
"Caller": {
"DynamicName": "some-caller"
},
"Closed": false,
"Completed": false,
"CreationDate": "2021-03-24T08:15:13.867+0000",
"Creator": {
"Id": "some-id-1",
"Name": "Xsoar - Operator"
},
"ExternalNumber": "",
"Id": "some-id",
"MajorCall": false,
"ModificationDate": "2021-03-24T08:15:13.000+0000",
"Modifier": {
"Id": "some-id-1",
"Name": "Xsoar - Operator"
},
"Monitored": false,
"Number": "XSOAR-1337",
"OnHold": false,
"OptionalFields1": {
"Searchlist1": {
"Id": "some-id-3",
"Name": "Some Search Name"
},
"Searchlist3": {
"Id": "some-id-4",
"Name": "Some Other Search Name"
},
"Text1": "",
"Text2": "",
"Text3": "",
"Text4": "",
"Text5": ""
},
"OptionalFields2": {
"Text1": "",
"Text2": "",
"Text3": "",
"Text4": "",
"Text5": ""
},
"ProcessingStatus": {
"Id": "some-processing-status-id",
"Name": "Logged"
},
"PublishToSsd": false,
"Requests": "/tas/api/incidents/id/some-id/requests",
"Responded": false,
"Status": "firstLine"
}
]
}
}

Human Readable Output#

TOPdesk incidents#

IdNumberLineCallerNameStatus
some-idXSOAR-1337firstLinesome-callerLogged

topdesk-incident-update#

Update an incident in TOPdesk.

Permissions:#

Operator: With edit permission on 1st/2nd line incident; Category/Branch/Operator filters apply

Person: Accessible; Person visibility settings apply. Depending on settings, the following fields can be updated:

  • action
  • closed
  • feedbackRating
  • feedbackMessage

Base Command#

topdesk-incident-update

Input#

Argument NameDescriptionRequired
idThe incident ID. An ID or a number must be set. If both are set incident with relevant ID will be updated.Optional
number.The incident number. An ID or a number must be set. If both are set incident with relevant ID will be updated.Optional
status.Status of the incident. Can only be set by operators. Possible values are: firstLine, secondLine, partial.Optional
descriptionBrief description. maximum 80 characters.Optional
requestInitial request. Can be set by operators and persons.Optional
actionInitial action. Can be set by operators and persons.Optional
callerThe caller ID for this incident. For an unregistered caller provide a name.Optional
action_invisible_for_callerWhether the initial action is invisible for persons. Can only be set by operators. Default value is false. Possible values are: true, false.Optional
entry_typeEntry type by name. Can only be set by operators. XSOAR is set by default for mirroring.Optional
categoryCategory by name. Can be set by operators. It is an error to provide both an ID and a name.Optional
subcategorySubcategory by name. Can be set by operators. It is an error to provide both an ID and a name.Optional
external_numberExternal number. Can only be set by operators. Max 60 characters.Optional
main_incidentMain incident ID or number, required for creating a partial incident. Can only be set by operators.Optional
additional_paramsAdditional parameters to pass when creating an incident. (e.g., {"optionalFields1":{"text1":"test"}})Optional

Context Output#

PathTypeDescription
TOPdesk.Incident.IdStringTOPdesk incident's ID.
TOPdesk.Incident.StatusStringTOPdesk incident's status.
TOPdesk.Incident.NumberStringTOPdesk incident's number.
TOPdesk.Incident.RequestStringTOPdesk incident's request.
TOPdesk.Incident.RequestsStringTOPdesk incident's requests.
TOPdesk.Incident.ActionStringTOPdesk incident's action.
TOPdesk.Incident.AttachmentsStringTOPdesk incident's attachments.
TOPdesk.Incident.Caller.IdStringTOPdesk incident's caller ID.
TOPdesk.Incident.Caller.DynamicNameStringTOPdesk incident's caller dynamic name.
TOPdesk.Incident.Caller.Branch.ClientReferenceNumberStringTOPdesk incident's caller branch client reference number.
TOPdesk.Incident.Caller.Branch.TimeZoneStringTOPdesk incident's caller branch timezone.
TOPdesk.Incident.Caller.Branch.ExtraAUnknownTOPdesk incident's caller branch extra A.
TOPdesk.Incident.Caller.Branch.ExtraBUnknownTOPdesk incident's caller branch extra B.
TOPdesk.Incident.Caller.Branch.IdStringTOPdesk incident's caller branch ID.
TOPdesk.Incident.Caller.Branch.NameStringTOPdesk incident's caller branch name.
TOPdesk.Incident.CallerBranch.ClientReferenceNumberStringTOPdesk incident's caller branch client reference number.
TOPdesk.Incident.CallerBranch.TimeZoneStringTOPdesk incident's caller branch timezone.
TOPdesk.Incident.CallerBranch.ExtraAUnknownTOPdesk incident's caller branch extra A.
TOPdesk.Incident.CallerBranch.ExtraBUnknownTOPdesk incident's caller branch extra B.
TOPdesk.Incident.CallerBranch.IdStringTOPdesk incident's caller branch ID.
TOPdesk.Incident.CallerBranch.NameStringTOPdesk incident's caller branch name.
TOPdesk.Incident.BranchExtraFieldAUnknownTOPdesk incident's branch extra field A.
TOPdesk.Incident.BranchExtraFieldBUnknownTOPdesk incident's branch extra field B.
TOPdesk.Incident.BriefDescriptionStringTOPdesk incident's brief description.
TOPdesk.Incident.ExternalNumberStringTOPdesk incident's external number.
TOPdesk.Incident.Category.IdStringTOPdesk incident's category ID.
TOPdesk.Incident.Category.NameStringTOPdesk incident's category name.
TOPdesk.Incident.Subcategory.IdStringTOPdesk incident's subcategory ID.
TOPdesk.Incident.Subcategory.NameStringTOPdesk incident's subcategory name.
TOPdesk.Incident.CallType.IdStringTOPdesk incident's call type ID.
TOPdesk.Incident.CallType.NameStringTOPdesk incident's call type name.
TOPdesk.Incident.EntryType.IdStringTOPdesk incident's entry type ID.
TOPdesk.Incident.EntryType.NameStringTOPdesk incident's entry type name.
TOPdesk.Incident.Object.IdStringTOPdesk incident's object ID.
TOPdesk.Incident.Object.NameStringTOPdesk incident's object name.
TOPdesk.Incident.Object.Type.IdStringTOPdesk incident's object type ID.
TOPdesk.Incident.Object.Type.NameStringTOPdesk incident's object type name.
TOPdesk.Incident.Object.Make.IdStringTOPdesk incident's object make ID.
TOPdesk.Incident.Object.Make.NameStringTOPdesk incident's object make name.
TOPdesk.Incident.Object.Model.IdStringTOPdesk incident's object model ID.
TOPdesk.Incident.Object.Model.NameStringTOPdesk incident's object model name.
TOPdesk.Incident.Object.Branch.IdStringTOPdesk incident's object branch ID.
TOPdesk.Incident.Object.Branch.NameStringTOPdesk incident's object branch name.
TOPdesk.Incident.Object.Location.IdStringTOPdesk incident's object location ID.
TOPdesk.Incident.Object.Location.NameStringTOPdesk incident's object location name.
TOPdesk.Incident.Object.SpecificationStringTOPdesk incident's object specification.
TOPdesk.Incident.Object.SerialNumberStringTOPdesk incident's object serial number.
TOPdesk.Incident.Asset.IdStringTOPdesk incident's asset ID.
TOPdesk.Incident.Branch.ClientReferenceNumberStringTOPdesk incident's branch client reference number.
TOPdesk.Incident.Branch.TimeZoneStringTOPdesk incident's branch timezone.
TOPdesk.Incident.Branch.ExtraAUnknownTOPdesk incident's branch extra A.
TOPdesk.Incident.Branch.ExtraBUnknownTOPdesk incident's branch extra B.
TOPdesk.Incident.Branch.IdStringTOPdesk incident's branch ID.
TOPdesk.Incident.Branch.NameStringTOPdesk incident's branch name.
TOPdesk.Incident.Location.IdStringTOPdesk incident's location ID.
TOPdesk.Incident.Location.Branch.ClientReferenceNumberStringTOPdesk incident's location branch client reference number.
TOPdesk.Incident.Location.Branch.TimeZoneStringTOPdesk incident's location branch timezone.
TOPdesk.Incident.Location.Branch.ExtraAUnknownTOPdesk incident's location branch extra A.
TOPdesk.Incident.Location.Branch.ExtraBUnknownTOPdesk incident's location branch extra B.
TOPdesk.Incident.Location.Branch.IdStringTOPdesk incident's location branch ID.
TOPdesk.Incident.Location.Branch.NameStringTOPdesk incident's location branch name.
TOPdesk.Incident.Location.NameStringTOPdesk incident's location name.
TOPdesk.Incident.Location.RoomStringTOPdesk incident's location room.
TOPdesk.Incident.Impact.IdStringTOPdesk incident's impact ID.
TOPdesk.Incident.Impact.NameStringTOPdesk incident's impact name.
TOPdesk.Incident.Urgency.IdStringTOPdesk incident's urgency ID.
TOPdesk.Incident.Urgency.NameStringTOPdesk incident's urgency name.
TOPdesk.Incident.Priority.IdStringTOPdesk incident's priority ID.
TOPdesk.Incident.Priority.NameStringTOPdesk incident's priority name.
TOPdesk.Incident.Duration.IdStringTOPdesk incident's duration ID.
TOPdesk.Incident.Duration.NameStringTOPdesk incident's duration name.
TOPdesk.Incident.TargetDateDateTOPdesk incident's target date.
TOPdesk.Incident.Sla.IdStringTOPdesk incident's sla ID.
TOPdesk.Incident.OnHoldBooleanTOPdesk incident's on hold.
TOPdesk.Incident.OnHoldDateUnknownTOPdesk incident's on hold date.
TOPdesk.Incident.OnHoldDurationNumberTOPdesk incident's on hold duration.
TOPdesk.Incident.FeedbackMessageUnknownTOPdesk incident's feedback message.
TOPdesk.Incident.FeedbackRatingUnknownTOPdesk incident's feedback rating.
TOPdesk.Incident.Operator.IdStringTOPdesk incident's operator ID.
TOPdesk.Incident.Operator.StatusStringTOPdesk incident's operator status.
TOPdesk.Incident.Operator.NameStringTOPdesk incident's operator name.
TOPdesk.Incident.OperatorGroup.IdStringTOPdesk incident's operator group ID.
TOPdesk.Incident.OperatorGroup.NameStringTOPdesk incident's operator group name.
TOPdesk.Incident.Supplier.IdStringTOPdesk incident's supplier ID.
TOPdesk.Incident.Supplier.NameStringTOPdesk incident's supplier name.
TOPdesk.Incident.Supplier.ForFirstLineBooleanTOPdesk incident's supplier for first line.
TOPdesk.Incident.Supplier.ForSecondLineBooleanTOPdesk incident's supplier for second line.
TOPdesk.Incident.ProcessingStatus.IdStringTOPdesk incident's processing status ID.
TOPdesk.Incident.ProcessingStatus.NameStringTOPdesk incident's processing status name.
TOPdesk.Incident.CompletedBooleanTOPdesk incident's completed.
TOPdesk.Incident.CompletedDateUnknownTOPdesk incident's completed date.
TOPdesk.Incident.ClosedBooleanTOPdesk incident's closed.
TOPdesk.Incident.ClosedDateUnknownTOPdesk incident's closed date.
TOPdesk.Incident.ClosureCode.IdStringTOPdesk incident's closure code ID.
TOPdesk.Incident.ClosureCode.NameStringTOPdesk incident's closure code name.
TOPdesk.Incident.TimeSpentNumberTOPdesk incident's time spent.
TOPdesk.Incident.TimeSpentFirstLineNumberTOPdesk incident's time spent first line
TOPdesk.Incident.TimeSpentSecondLineAndPartialsNumberTOPdesk incident's time spent second line and partials.
TOPdesk.Incident.CostsNumberTOPdesk incident's costs.
TOPdesk.Incident.EscalationStatusStringTOPdesk incident's escalation status.
TOPdesk.Incident.EscalationReason.IdStringTOPdesk incident's escalation reason ID.
TOPdesk.Incident.EscalationReason.NameStringTOPdesk incident's escalation reason name.
TOPdesk.Incident.EscalationOperator.IdStringTOPdesk incident's escalation operator ID.
TOPdesk.Incident.EscalationOperator.NameStringTOPdesk incident's escalation operator name.
TOPdesk.Incident.CallDateDateTOPdesk incident's call date.
TOPdesk.Incident.Creator.IdStringTOPdesk incident's creator ID.
TOPdesk.Incident.Creator.NameStringTOPdesk incident's creator name.
TOPdesk.Incident.CreationDateDateTOPdesk incident's creation date.
TOPdesk.Incident.Modifier.IdStringTOPdesk incident's modifier ID.
TOPdesk.Incident.Modifier.NameStringTOPdesk incident's modifier name.
TOPdesk.Incident.ModificationDateDateTOPdesk incident's modification date.
TOPdesk.Incident.MajorCallBooleanTOPdesk incident's major call.
TOPdesk.Incident.MajorCallObject.NameStringTOPdesk incident's Major call object name.
TOPdesk.Incident.MajorCallObject.IdStringTOPdesk incident's major call object ID.
TOPdesk.Incident.MajorCallObject.StatusNumberTOPdesk incident's major call object status.
TOPdesk.Incident.MajorCallObject.MajorIncidentBooleanTOPdesk incident's major call object major incident.
TOPdesk.Incident.PublishToSsdBooleanTOPdesk incident's publish to SSD.
TOPdesk.Incident.MonitoredBooleanTOPdesk incident's monitored.
TOPdesk.Incident.ExpectedTimeSpentNumberTOPdesk incident's expected time spent.
TOPdesk.Incident.MainIncidentUnknownTOPdesk incident's main incident.
TOPdesk.Incident.PartialIncidents.LinkStringTOPdesk incident's partial incidents link.
TOPdesk.Incident.OptionalFields1.Boolean1BooleanTOPdesk incident's optional fields1 boolean1.
TOPdesk.Incident.OptionalFields1.Boolean2BooleanTOPdesk incident's optional fields1 boolean2.
TOPdesk.Incident.OptionalFields1.Boolean3BooleanTOPdesk incident's optional fields1 boolean3.
TOPdesk.Incident.OptionalFields1.Boolean4BooleanTOPdesk incident's optional fields1 boolean4.
TOPdesk.Incident.OptionalFields1.Boolean5BooleanTOPdesk incident's optional fields1 boolean5.
TOPdesk.Incident.OptionalFields1.Number1NumberTOPdesk incident's optional fields1 number1.
TOPdesk.Incident.OptionalFields1.Number2NumberTOPdesk incident's optional fields1 number2.
TOPdesk.Incident.OptionalFields1.Number3NumberTOPdesk incident's optional fields1 number3.
TOPdesk.Incident.OptionalFields1.Number4NumberTOPdesk incident's optional fields1 number4.
TOPdesk.Incident.OptionalFields1.Number5NumberTOPdesk incident's optional fields1 number5.
TOPdesk.Incident.OptionalFields1.Date1DateTOPdesk incident's optional fields1 date1.
TOPdesk.Incident.OptionalFields1.Date2DateTOPdesk incident's optional fields1 date2.
TOPdesk.Incident.OptionalFields1.Date3DateTOPdesk incident's optional fields1 date3.
TOPdesk.Incident.OptionalFields1.Date4DateTOPdesk incident's optional fields1 date4.
TOPdesk.Incident.OptionalFields1.Date5DateTOPdesk incident's optional fields1 date5.
TOPdesk.Incident.OptionalFields1.Text1StringTOPdesk incident's optional fields1 text1.
TOPdesk.Incident.OptionalFields1.Text2StringTOPdesk incident's optional fields1 text2.
TOPdesk.Incident.OptionalFields1.Text3StringTOPdesk incident's optional fields1 text3.
TOPdesk.Incident.OptionalFields1.Text4StringTOPdesk incident's optional fields1 text4.
TOPdesk.Incident.OptionalFields1.Text5StringTOPdesk incident's optional fields1 text5.
TOPdesk.Incident.OptionalFields1.Memo1StringTOPdesk incident's optional fields1 memo1.
TOPdesk.Incident.OptionalFields1.Memo2StringTOPdesk incident's optional fields1 memo2.
TOPdesk.Incident.OptionalFields1.Memo3StringTOPdesk incident's optional fields1 memo3.
TOPdesk.Incident.OptionalFields1.Memo4StringTOPdesk incident's optional fields1 memo4.
TOPdesk.Incident.OptionalFields1.Memo5StringTOPdesk incident's optional fields1 memo5.
TOPdesk.Incident.OptionalFields1.Searchlist1.IdStringTOPdesk incident's optional fields1 searchlist1 ID.
TOPdesk.Incident.OptionalFields1.Searchlist1.NameStringTOPdesk incident's optional fields1 searchlist1 name.
TOPdesk.Incident.OptionalFields1.Searchlist2.IdStringTOPdesk incident's optional fields1 searchlist2 ID.
TOPdesk.Incident.OptionalFields1.Searchlist2.NameStringTOPdesk incident's optional fields1 searchlist2 name.
TOPdesk.Incident.OptionalFields1.Searchlist3.IdStringTOPdesk incident's optional fields1 searchlist3 ID.
TOPdesk.Incident.OptionalFields1.Searchlist3.NameStringTOPdesk incident's optional fields1 searchlist3 name.
TOPdesk.Incident.OptionalFields1.Searchlist4.IdStringTOPdesk incident's optional fields1 searchlist4 ID.
TOPdesk.Incident.OptionalFields1.Searchlist4.NameStringTOPdesk incident's optional fields1 searchlist4 name.
TOPdesk.Incident.OptionalFields1.Searchlist5.IdStringTOPdesk incident's optional fields1 searchlist5 ID.
TOPdesk.Incident.OptionalFields1.Searchlist5.NameStringTOPdesk incident's optional fields1 searchlist5 name.
TOPdesk.Incident.OptionalFields2.Boolean1BooleanTOPdesk incident's optional fields2 boolean1.
TOPdesk.Incident.OptionalFields2.Boolean2BooleanTOPdesk incident's optional fields2 boolean2.
TOPdesk.Incident.OptionalFields2.Boolean3BooleanTOPdesk incident's optional fields2 boolean3.
TOPdesk.Incident.OptionalFields2.Boolean4BooleanTOPdesk incident's optional fields2 boolean4.
TOPdesk.Incident.OptionalFields2.Boolean5BooleanTOPdesk incident's optional fields2 boolean5.
TOPdesk.Incident.OptionalFields2.Number1NumberTOPdesk incident's optional fields2 number1.
TOPdesk.Incident.OptionalFields2.Number2NumberTOPdesk incident's optional fields2 number2.
TOPdesk.Incident.OptionalFields2.Number3NumberTOPdesk incident's optional fields2 number3.
TOPdesk.Incident.OptionalFields2.Number4NumberTOPdesk incident's optional fields2 number4.
TOPdesk.Incident.OptionalFields2.Number5NumberTOPdesk incident's optional fields2 number5.
TOPdesk.Incident.OptionalFields2.Date1DateTOPdesk incident's optional fields2 date1.
TOPdesk.Incident.OptionalFields2.Date2DateTOPdesk incident's optional fields2 date2.
TOPdesk.Incident.OptionalFields2.Date3DateTOPdesk incident's optional fields2 date3.
TOPdesk.Incident.OptionalFields2.Date4DateTOPdesk incident's optional fields2 date4.
TOPdesk.Incident.OptionalFields2.Date5DateTOPdesk incident's optional fields2 date5.
TOPdesk.Incident.OptionalFields2.Text1StringTOPdesk incident's optional fields2 text1.
TOPdesk.Incident.OptionalFields2.Text2StringTOPdesk incident's optional fields2 text2.
TOPdesk.Incident.OptionalFields2.Text3StringTOPdesk incident's Optional fields2.text3
TOPdesk.Incident.OptionalFields2.Text4StringTOPdesk incident's optional fields2 text4.
TOPdesk.Incident.OptionalFields2.Text5StringTOPdesk incident's optional fields2 text5.
TOPdesk.Incident.OptionalFields2.Memo1StringTOPdesk incident's optional fields2 memo1.
TOPdesk.Incident.OptionalFields2.Memo2StringTOPdesk incident's optional fields2 memo2.
TOPdesk.Incident.OptionalFields2.Memo3StringTOPdesk incident's optional fields2 memo3.
TOPdesk.Incident.OptionalFields2.Memo4StringTOPdesk incident's optional fields2 memo4.
TOPdesk.Incident.OptionalFields2.Memo5StringTOPdesk incident's optional fields2 memo5.
TOPdesk.Incident.OptionalFields2.Searchlist1.IdStringTOPdesk incident's optional fields2 searchlist1 ID.
TOPdesk.Incident.OptionalFields2.Searchlist1.NameStringTOPdesk incident's optional fields2 searchlist1 name.
TOPdesk.Incident.OptionalFields2.Searchlist2.IdStringTOPdesk incident's optional fields2 searchlist2 ID.
TOPdesk.Incident.OptionalFields2.Searchlist2.NameStringTOPdesk incident's optional fields2 searchlist2 name.
TOPdesk.Incident.OptionalFields2.Searchlist3.IdStringTOPdesk incident's optional fields2 searchlist3 ID.
TOPdesk.Incident.OptionalFields2.Searchlist3.NameStringTOPdesk incident's optional fields2 searchlist3 name.
TOPdesk.Incident.OptionalFields2.Searchlist4.IdStringTOPdesk incident's optional fields2 searchlist4 ID.
TOPdesk.Incident.OptionalFields2.Searchlist4.NameStringTOPdesk incident's optional fields2 searchlist4 name.
TOPdesk.Incident.OptionalFields2.Searchlist5.IdStringTOPdesk incident's optional fields2 searchlist5 ID.
TOPdesk.Incident.OptionalFields2.Searchlist5.NameStringTOPdesk incident's optional fields2 searchlist5 name.
TOPdesk.Incident.ExternalLinks.IdStringTOPdesk incident's external links ID.
TOPdesk.Incident.ExternalLinks.TypeStringTOPdesk incident's external links type.
TOPdesk.Incident.ExternalLinks.DateDateTOPdesk incident's external links date.

Command Example#

!topdesk-incident-update description=some-updated-description number=XSOAR-1337

Context Example#

{
"TOPdesk": {
"Incident": [
{
"Action": "/tas/api/incidents/id/some-id/actions",
"Attachments": "/tas/api/incidents/id/some-id/attachments",
"BriefDescription": "some-updated-description",
"CallDate": "2021-03-24T08:15:13.867+0000",
"Caller": {
"DynamicName": "some-caller"
},
"Closed": false,
"Completed": false,
"CreationDate": "2021-03-24T08:15:13.867+0000",
"Creator": {
"Id": "some-id-1",
"Name": "Xsoar - Operator"
},
"ExternalNumber": "",
"Id": "some-id",
"MajorCall": false,
"ModificationDate": "2021-03-24T08:15:13.000+0000",
"Modifier": {
"Id": "some-id-1",
"Name": "Xsoar - Operator"
},
"Monitored": false,
"Number": "XSOAR-1337",
"OnHold": false,
"OptionalFields1": {
"Searchlist1": {
"Id": "some-id-3",
"Name": "Some Search Name"
},
"Searchlist3": {
"Id": "some-id-4",
"Name": "Some Other Search Name"
},
"Text1": "",
"Text2": "",
"Text3": "",
"Text4": "",
"Text5": ""
},
"OptionalFields2": {
"Text1": "",
"Text2": "",
"Text3": "",
"Text4": "",
"Text5": ""
},
"ProcessingStatus": {
"Id": "some-processing-status-id",
"Name": "Logged"
},
"PublishToSsd": false,
"Requests": "/tas/api/incidents/id/some-id/requests",
"Responded": false,
"Status": "firstLine"
}
]
}
}

Human Readable Output#

TOPdesk incidents#

IdNumberLineCallerNameStatus
some-idXSOAR-1337firstLinesome-callerLogged

topdesk-incident-escalate#

Escalate an incident in TOPdesk.

Permissions#

Operator: With 1st line incident write permission and write permission for escalating incidents; Category/Branch/Operator filters apply

Person: No access

Base Command#

topdesk-incident-escalate

Input#

Argument NameDescriptionRequired
idThe incident ID. An ID or a number must be set. If both are set incident with relevant ID will be updated.Optional
number.The incident number. An ID or a number must be set. If both are set incident with relevant ID will be updated.Optional
escalate_reason_idThe escalation reason ID.Required

Context Output#

PathTypeDescription
TOPdesk.Incident.IdStringTOPdesk incident's ID.
TOPdesk.Incident.StatusStringTOPdesk incident's status.
TOPdesk.Incident.NumberStringTOPdesk incident's number.
TOPdesk.Incident.RequestStringTOPdesk incident's request.
TOPdesk.Incident.RequestsStringTOPdesk incident's requests.
TOPdesk.Incident.ActionStringTOPdesk incident's action.
TOPdesk.Incident.AttachmentsStringTOPdesk incident's attachments.
TOPdesk.Incident.Caller.IdStringTOPdesk incident's caller ID.
TOPdesk.Incident.Caller.DynamicNameStringTOPdesk incident's caller dynamic name.
TOPdesk.Incident.Caller.Branch.ClientReferenceNumberStringTOPdesk incident's caller branch client reference number.
TOPdesk.Incident.Caller.Branch.TimeZoneStringTOPdesk incident's caller branch timezone.
TOPdesk.Incident.Caller.Branch.ExtraAUnknownTOPdesk incident's caller branch extra A.
TOPdesk.Incident.Caller.Branch.ExtraBUnknownTOPdesk incident's caller branch extra B.
TOPdesk.Incident.Caller.Branch.IdStringTOPdesk incident's caller branch ID.
TOPdesk.Incident.Caller.Branch.NameStringTOPdesk incident's caller branch name.
TOPdesk.Incident.CallerBranch.ClientReferenceNumberStringTOPdesk incident's caller branch client reference number.
TOPdesk.Incident.CallerBranch.TimeZoneStringTOPdesk incident's caller branch timezone.
TOPdesk.Incident.CallerBranch.ExtraAUnknownTOPdesk incident's caller branch extra A.
TOPdesk.Incident.CallerBranch.ExtraBUnknownTOPdesk incident's caller branch extra B.
TOPdesk.Incident.CallerBranch.IdStringTOPdesk incident's caller branch ID.
TOPdesk.Incident.CallerBranch.NameStringTOPdesk incident's caller branch name.
TOPdesk.Incident.BranchExtraFieldAUnknownTOPdesk incident's branch extra field A.
TOPdesk.Incident.BranchExtraFieldBUnknownTOPdesk incident's branch extra field B.
TOPdesk.Incident.BriefDescriptionStringTOPdesk incident's brief description.
TOPdesk.Incident.ExternalNumberStringTOPdesk incident's external number.
TOPdesk.Incident.Category.IdStringTOPdesk incident's category ID.
TOPdesk.Incident.Category.NameStringTOPdesk incident's category name.
TOPdesk.Incident.Subcategory.IdStringTOPdesk incident's subcategory ID.
TOPdesk.Incident.Subcategory.NameStringTOPdesk incident's subcategory name.
TOPdesk.Incident.CallType.IdStringTOPdesk incident's call type ID.
TOPdesk.Incident.CallType.NameStringTOPdesk incident's call type name.
TOPdesk.Incident.EntryType.IdStringTOPdesk incident's entry type ID.
TOPdesk.Incident.EntryType.NameStringTOPdesk incident's entry type name.
TOPdesk.Incident.Object.IdStringTOPdesk incident's object ID.
TOPdesk.Incident.Object.NameStringTOPdesk incident's object name.
TOPdesk.Incident.Object.Type.IdStringTOPdesk incident's object type ID.
TOPdesk.Incident.Object.Type.NameStringTOPdesk incident's object type name.
TOPdesk.Incident.Object.Make.IdStringTOPdesk incident's object make ID.
TOPdesk.Incident.Object.Make.NameStringTOPdesk incident's object make name.
TOPdesk.Incident.Object.Model.IdStringTOPdesk incident's object model ID.
TOPdesk.Incident.Object.Model.NameStringTOPdesk incident's object model name.
TOPdesk.Incident.Object.Branch.IdStringTOPdesk incident's object branch ID.
TOPdesk.Incident.Object.Branch.NameStringTOPdesk incident's object branch name.
TOPdesk.Incident.Object.Location.IdStringTOPdesk incident's object location ID.
TOPdesk.Incident.Object.Location.NameStringTOPdesk incident's object location name.
TOPdesk.Incident.Object.SpecificationStringTOPdesk incident's object specification.
TOPdesk.Incident.Object.SerialNumberStringTOPdesk incident's object serial number.
TOPdesk.Incident.Asset.IdStringTOPdesk incident's asset ID.
TOPdesk.Incident.Branch.ClientReferenceNumberStringTOPdesk incident's branch client reference number.
TOPdesk.Incident.Branch.TimeZoneStringTOPdesk incident's branch timezone.
TOPdesk.Incident.Branch.ExtraAUnknownTOPdesk incident's branch extra A.
TOPdesk.Incident.Branch.ExtraBUnknownTOPdesk incident's branch extra B.
TOPdesk.Incident.Branch.IdStringTOPdesk incident's branch ID.
TOPdesk.Incident.Branch.NameStringTOPdesk incident's branch name.
TOPdesk.Incident.Location.IdStringTOPdesk incident's location ID.
TOPdesk.Incident.Location.Branch.ClientReferenceNumberStringTOPdesk incident's location branch client reference number.
TOPdesk.Incident.Location.Branch.TimeZoneStringTOPdesk incident's location branch timezone.
TOPdesk.Incident.Location.Branch.ExtraAUnknownTOPdesk incident's location branch extra A.
TOPdesk.Incident.Location.Branch.ExtraBUnknownTOPdesk incident's location branch extra B.
TOPdesk.Incident.Location.Branch.IdStringTOPdesk incident's location branch ID.
TOPdesk.Incident.Location.Branch.NameStringTOPdesk incident's location branch name.
TOPdesk.Incident.Location.NameStringTOPdesk incident's location name.
TOPdesk.Incident.Location.RoomStringTOPdesk incident's location room.
TOPdesk.Incident.Impact.IdStringTOPdesk incident's impact ID.
TOPdesk.Incident.Impact.NameStringTOPdesk incident's impact name.
TOPdesk.Incident.Urgency.IdStringTOPdesk incident's urgency ID.
TOPdesk.Incident.Urgency.NameStringTOPdesk incident's urgency name.
TOPdesk.Incident.Priority.IdStringTOPdesk incident's priority ID.
TOPdesk.Incident.Priority.NameStringTOPdesk incident's priority name.
TOPdesk.Incident.Duration.IdStringTOPdesk incident's duration ID.
TOPdesk.Incident.Duration.NameStringTOPdesk incident's duration name.
TOPdesk.Incident.TargetDateDateTOPdesk incident's target date.
TOPdesk.Incident.Sla.IdStringTOPdesk incident's sla ID.
TOPdesk.Incident.OnHoldBooleanTOPdesk incident's on hold.
TOPdesk.Incident.OnHoldDateUnknownTOPdesk incident's on hold date.
TOPdesk.Incident.OnHoldDurationNumberTOPdesk incident's on hold duration.
TOPdesk.Incident.FeedbackMessageUnknownTOPdesk incident's feedback message.
TOPdesk.Incident.FeedbackRatingUnknownTOPdesk incident's feedback rating.
TOPdesk.Incident.Operator.IdStringTOPdesk incident's operator ID.
TOPdesk.Incident.Operator.StatusStringTOPdesk incident's operator status.
TOPdesk.Incident.Operator.NameStringTOPdesk incident's operator name.
TOPdesk.Incident.OperatorGroup.IdStringTOPdesk incident's operator group ID.
TOPdesk.Incident.OperatorGroup.NameStringTOPdesk incident's operator group name.
TOPdesk.Incident.Supplier.IdStringTOPdesk incident's supplier ID.
TOPdesk.Incident.Supplier.NameStringTOPdesk incident's supplier name.
TOPdesk.Incident.Supplier.ForFirstLineBooleanTOPdesk incident's supplier for first line.
TOPdesk.Incident.Supplier.ForSecondLineBooleanTOPdesk incident's supplier for second line.
TOPdesk.Incident.ProcessingStatus.IdStringTOPdesk incident's processing status ID.
TOPdesk.Incident.ProcessingStatus.NameStringTOPdesk incident's processing status name.
TOPdesk.Incident.CompletedBooleanTOPdesk incident's completed.
TOPdesk.Incident.CompletedDateUnknownTOPdesk incident's completed date.
TOPdesk.Incident.ClosedBooleanTOPdesk incident's closed.
TOPdesk.Incident.ClosedDateUnknownTOPdesk incident's closed date.
TOPdesk.Incident.ClosureCode.IdStringTOPdesk incident's closure code ID.
TOPdesk.Incident.ClosureCode.NameStringTOPdesk incident's closure code name.
TOPdesk.Incident.TimeSpentNumberTOPdesk incident's time spent.
TOPdesk.Incident.TimeSpentFirstLineNumberTOPdesk incident's time spent first line
TOPdesk.Incident.TimeSpentSecondLineAndPartialsNumberTOPdesk incident's time spent second line and partials.
TOPdesk.Incident.CostsNumberTOPdesk incident's costs.
TOPdesk.Incident.EscalationStatusStringTOPdesk incident's escalation status.
TOPdesk.Incident.EscalationReason.IdStringTOPdesk incident's escalation reason ID.
TOPdesk.Incident.EscalationReason.NameStringTOPdesk incident's escalation reason name.
TOPdesk.Incident.EscalationOperator.IdStringTOPdesk incident's escalation operator ID.
TOPdesk.Incident.EscalationOperator.NameStringTOPdesk incident's escalation operator name.
TOPdesk.Incident.CallDateDateTOPdesk incident's call date.
TOPdesk.Incident.Creator.IdStringTOPdesk incident's creator ID.
TOPdesk.Incident.Creator.NameStringTOPdesk incident's creator name.
TOPdesk.Incident.CreationDateDateTOPdesk incident's creation date.
TOPdesk.Incident.Modifier.IdStringTOPdesk incident's modifier ID.
TOPdesk.Incident.Modifier.NameStringTOPdesk incident's modifier name.
TOPdesk.Incident.ModificationDateDateTOPdesk incident's modification date.
TOPdesk.Incident.MajorCallBooleanTOPdesk incident's major call.
TOPdesk.Incident.MajorCallObject.NameStringTOPdesk incident's Major call object name.
TOPdesk.Incident.MajorCallObject.IdStringTOPdesk incident's major call object ID.
TOPdesk.Incident.MajorCallObject.StatusNumberTOPdesk incident's major call object status.
TOPdesk.Incident.MajorCallObject.MajorIncidentBooleanTOPdesk incident's major call object major incident.
TOPdesk.Incident.PublishToSsdBooleanTOPdesk incident's publish to SSD.
TOPdesk.Incident.MonitoredBooleanTOPdesk incident's monitored.
TOPdesk.Incident.ExpectedTimeSpentNumberTOPdesk incident's expected time spent.
TOPdesk.Incident.MainIncidentUnknownTOPdesk incident's main incident.
TOPdesk.Incident.PartialIncidents.LinkStringTOPdesk incident's partial incidents link.
TOPdesk.Incident.OptionalFields1.Boolean1BooleanTOPdesk incident's optional fields1 boolean1.
TOPdesk.Incident.OptionalFields1.Boolean2BooleanTOPdesk incident's optional fields1 boolean2.
TOPdesk.Incident.OptionalFields1.Boolean3BooleanTOPdesk incident's optional fields1 boolean3.
TOPdesk.Incident.OptionalFields1.Boolean4BooleanTOPdesk incident's optional fields1 boolean4.
TOPdesk.Incident.OptionalFields1.Boolean5BooleanTOPdesk incident's optional fields1 boolean5.
TOPdesk.Incident.OptionalFields1.Number1NumberTOPdesk incident's optional fields1 number1.
TOPdesk.Incident.OptionalFields1.Number2NumberTOPdesk incident's optional fields1 number2.
TOPdesk.Incident.OptionalFields1.Number3NumberTOPdesk incident's optional fields1 number3.
TOPdesk.Incident.OptionalFields1.Number4NumberTOPdesk incident's optional fields1 number4.
TOPdesk.Incident.OptionalFields1.Number5NumberTOPdesk incident's optional fields1 number5.
TOPdesk.Incident.OptionalFields1.Date1DateTOPdesk incident's optional fields1 date1.
TOPdesk.Incident.OptionalFields1.Date2DateTOPdesk incident's optional fields1 date2.
TOPdesk.Incident.OptionalFields1.Date3DateTOPdesk incident's optional fields1 date3.
TOPdesk.Incident.OptionalFields1.Date4DateTOPdesk incident's optional fields1 date4.
TOPdesk.Incident.OptionalFields1.Date5DateTOPdesk incident's optional fields1 date5.
TOPdesk.Incident.OptionalFields1.Text1StringTOPdesk incident's optional fields1 text1.
TOPdesk.Incident.OptionalFields1.Text2StringTOPdesk incident's optional fields1 text2.
TOPdesk.Incident.OptionalFields1.Text3StringTOPdesk incident's optional fields1 text3.
TOPdesk.Incident.OptionalFields1.Text4StringTOPdesk incident's optional fields1 text4.
TOPdesk.Incident.OptionalFields1.Text5StringTOPdesk incident's optional fields1 text5.
TOPdesk.Incident.OptionalFields1.Memo1StringTOPdesk incident's optional fields1 memo1.
TOPdesk.Incident.OptionalFields1.Memo2StringTOPdesk incident's optional fields1 memo2.
TOPdesk.Incident.OptionalFields1.Memo3StringTOPdesk incident's optional fields1 memo3.
TOPdesk.Incident.OptionalFields1.Memo4StringTOPdesk incident's optional fields1 memo4.
TOPdesk.Incident.OptionalFields1.Memo5StringTOPdesk incident's optional fields1 memo5.
TOPdesk.Incident.OptionalFields1.Searchlist1.IdStringTOPdesk incident's optional fields1 searchlist1 ID.
TOPdesk.Incident.OptionalFields1.Searchlist1.NameStringTOPdesk incident's optional fields1 searchlist1 name.
TOPdesk.Incident.OptionalFields1.Searchlist2.IdStringTOPdesk incident's optional fields1 searchlist2 ID.
TOPdesk.Incident.OptionalFields1.Searchlist2.NameStringTOPdesk incident's optional fields1 searchlist2 name.
TOPdesk.Incident.OptionalFields1.Searchlist3.IdStringTOPdesk incident's optional fields1 searchlist3 ID.
TOPdesk.Incident.OptionalFields1.Searchlist3.NameStringTOPdesk incident's optional fields1 searchlist3 name.
TOPdesk.Incident.OptionalFields1.Searchlist4.IdStringTOPdesk incident's optional fields1 searchlist4 ID.
TOPdesk.Incident.OptionalFields1.Searchlist4.NameStringTOPdesk incident's optional fields1 searchlist4 name.
TOPdesk.Incident.OptionalFields1.Searchlist5.IdStringTOPdesk incident's optional fields1 searchlist5 ID.
TOPdesk.Incident.OptionalFields1.Searchlist5.NameStringTOPdesk incident's optional fields1 searchlist5 name.
TOPdesk.Incident.OptionalFields2.Boolean1BooleanTOPdesk incident's optional fields2 boolean1.
TOPdesk.Incident.OptionalFields2.Boolean2BooleanTOPdesk incident's optional fields2 boolean2.
TOPdesk.Incident.OptionalFields2.Boolean3BooleanTOPdesk incident's optional fields2 boolean3.
TOPdesk.Incident.OptionalFields2.Boolean4BooleanTOPdesk incident's optional fields2 boolean4.
TOPdesk.Incident.OptionalFields2.Boolean5BooleanTOPdesk incident's optional fields2 boolean5.
TOPdesk.Incident.OptionalFields2.Number1NumberTOPdesk incident's optional fields2 number1.
TOPdesk.Incident.OptionalFields2.Number2NumberTOPdesk incident's optional fields2 number2.
TOPdesk.Incident.OptionalFields2.Number3NumberTOPdesk incident's optional fields2 number3.
TOPdesk.Incident.OptionalFields2.Number4NumberTOPdesk incident's optional fields2 number4.
TOPdesk.Incident.OptionalFields2.Number5NumberTOPdesk incident's optional fields2 number5.
TOPdesk.Incident.OptionalFields2.Date1DateTOPdesk incident's optional fields2 date1.
TOPdesk.Incident.OptionalFields2.Date2DateTOPdesk incident's optional fields2 date2.
TOPdesk.Incident.OptionalFields2.Date3DateTOPdesk incident's optional fields2 date3.
TOPdesk.Incident.OptionalFields2.Date4DateTOPdesk incident's optional fields2 date4.
TOPdesk.Incident.OptionalFields2.Date5DateTOPdesk incident's optional fields2 date5.
TOPdesk.Incident.OptionalFields2.Text1StringTOPdesk incident's optional fields2 text1.
TOPdesk.Incident.OptionalFields2.Text2StringTOPdesk incident's optional fields2 text2.
TOPdesk.Incident.OptionalFields2.Text3StringTOPdesk incident's optional fields2.text3.
TOPdesk.Incident.OptionalFields2.Text4StringTOPdesk incident's optional fields2 text4.
TOPdesk.Incident.OptionalFields2.Text5StringTOPdesk incident's optional fields2 text5.
TOPdesk.Incident.OptionalFields2.Memo1StringTOPdesk incident's optional fields2 memo1.
TOPdesk.Incident.OptionalFields2.Memo2StringTOPdesk incident's optional fields2 memo2.
TOPdesk.Incident.OptionalFields2.Memo3StringTOPdesk incident's optional fields2 memo3.
TOPdesk.Incident.OptionalFields2.Memo4StringTOPdesk incident's optional fields2 memo4.
TOPdesk.Incident.OptionalFields2.Memo5StringTOPdesk incident's optional fields2 memo5.
TOPdesk.Incident.OptionalFields2.Searchlist1.IdStringTOPdesk incident's optional fields2 searchlist1 ID.
TOPdesk.Incident.OptionalFields2.Searchlist1.NameStringTOPdesk incident's optional fields2 searchlist1 name.
TOPdesk.Incident.OptionalFields2.Searchlist2.IdStringTOPdesk incident's optional fields2 searchlist2 ID.
TOPdesk.Incident.OptionalFields2.Searchlist2.NameStringTOPdesk incident's optional fields2 searchlist2 name.
TOPdesk.Incident.OptionalFields2.Searchlist3.IdStringTOPdesk incident's optional fields2 searchlist3 ID.
TOPdesk.Incident.OptionalFields2.Searchlist3.NameStringTOPdesk incident's optional fields2 searchlist3 name.
TOPdesk.Incident.OptionalFields2.Searchlist4.IdStringTOPdesk incident's optional fields2 searchlist4 ID.
TOPdesk.Incident.OptionalFields2.Searchlist4.NameStringTOPdesk incident's optional fields2 searchlist4 name.
TOPdesk.Incident.OptionalFields2.Searchlist5.IdStringTOPdesk incident's optional fields2 searchlist5 ID.
TOPdesk.Incident.OptionalFields2.Searchlist5.NameStringTOPdesk incident's optional fields2 searchlist5 name.
TOPdesk.Incident.ExternalLinks.IdStringTOPdesk incident's external links ID.
TOPdesk.Incident.ExternalLinks.TypeStringTOPdesk incident's external links type.
TOPdesk.Incident.ExternalLinks.DateDateTOPdesk incident's external links date.

Command Example#

!topdesk-incident-escalate number=XSOAR-1337 escalate_reason_id=some-escalation-id-1

Context Example#

{
"TOPdesk": {
"Incident": [
{
"Action": "/tas/api/incidents/id/some-id/actions",
"Attachments": "/tas/api/incidents/id/some-id/attachments",
"BriefDescription": "some-updated-description",
"CallDate": "2021-03-24T08:15:13.867+0000",
"Caller": {
"DynamicName": "some-caller"
},
"Closed": false,
"Completed": false,
"CreationDate": "2021-03-24T08:15:13.867+0000",
"Creator": {
"Id": "some-id-1",
"Name": "Xsoar - Operator"
},
"ExternalNumber": "",
"Id": "some-id",
"MajorCall": false,
"ModificationDate": "2021-03-24T08:15:13.000+0000",
"Modifier": {
"Id": "some-id-1",
"Name": "Xsoar - Operator"
},
"Monitored": false,
"Number": "XSOAR-1337",
"OnHold": false,
"OptionalFields1": {
"Searchlist1": {
"Id": "some-id-3",
"Name": "Some Search Name"
},
"Searchlist3": {
"Id": "some-id-4",
"Name": "Some Other Search Name"
},
"Text1": "",
"Text2": "",
"Text3": "",
"Text4": "",
"Text5": ""
},
"OptionalFields2": {
"Text1": "",
"Text2": "",
"Text3": "",
"Text4": "",
"Text5": ""
},
"ProcessingStatus": {
"Id": "some-processing-status-id",
"Name": "Logged"
},
"PublishToSsd": false,
"Requests": "/tas/api/incidents/id/some-id/requests",
"Responded": false,
"Status": "secondLine"
}
]
}
}

Human Readable Output#

TOPdesk incidents#

IdNumberLineCallerNameStatus
some-idXSOAR-1337secondLinesome-callerLogged

topdesk-incident-deescalate#

Deescalate an incident in TOPdesk.

Permissions#

Operator: With 1st and 2nd line incident write permission; Category/Branch/Operator filters apply; Feature must be enabled

Person: No access

Base Command#

topdesk-incident-deescalate

Input#

Argument NameDescriptionRequired
idThe incident ID. An ID or a number must be set. If both are set incident with relevant ID will be updated.Optional
number.The incident number. An ID or a number must be set. If both are set incident with relevant ID will be updated.Optional
deescalate_reason_idThe deescalation reason ID.Required

Context Output#

PathTypeDescription
TOPdesk.Incident.IdStringTOPdesk incident's ID.
TOPdesk.Incident.StatusStringTOPdesk incident's status.
TOPdesk.Incident.NumberStringTOPdesk incident's number.
TOPdesk.Incident.RequestStringTOPdesk incident's request.
TOPdesk.Incident.RequestsStringTOPdesk incident's requests.
TOPdesk.Incident.ActionStringTOPdesk incident's action.
TOPdesk.Incident.AttachmentsStringTOPdesk incident's attachments.
TOPdesk.Incident.Caller.IdStringTOPdesk incident's caller ID.
TOPdesk.Incident.Caller.DynamicNameStringTOPdesk incident's caller dynamic name.
TOPdesk.Incident.Caller.Branch.ClientReferenceNumberStringTOPdesk incident's caller branch client reference number.
TOPdesk.Incident.Caller.Branch.TimeZoneStringTOPdesk incident's caller branch timezone.
TOPdesk.Incident.Caller.Branch.ExtraAUnknownTOPdesk incident's caller branch extra A.
TOPdesk.Incident.Caller.Branch.ExtraBUnknownTOPdesk incident's caller branch extra B.
TOPdesk.Incident.Caller.Branch.IdStringTOPdesk incident's caller branch ID.
TOPdesk.Incident.Caller.Branch.NameStringTOPdesk incident's caller branch name.
TOPdesk.Incident.CallerBranch.ClientReferenceNumberStringTOPdesk incident's caller branch client reference number.
TOPdesk.Incident.CallerBranch.TimeZoneStringTOPdesk incident's caller branch timezone.
TOPdesk.Incident.CallerBranch.ExtraAUnknownTOPdesk incident's caller branch extra A.
TOPdesk.Incident.CallerBranch.ExtraBUnknownTOPdesk incident's caller branch extra B.
TOPdesk.Incident.CallerBranch.IdStringTOPdesk incident's caller branch ID.
TOPdesk.Incident.CallerBranch.NameStringTOPdesk incident's caller branch name.
TOPdesk.Incident.BranchExtraFieldAUnknownTOPdesk incident's branch extra field A.
TOPdesk.Incident.BranchExtraFieldBUnknownTOPdesk incident's branch extra field B.
TOPdesk.Incident.BriefDescriptionStringTOPdesk incident's brief description.
TOPdesk.Incident.ExternalNumberStringTOPdesk incident's external number.
TOPdesk.Incident.Category.IdStringTOPdesk incident's category ID.
TOPdesk.Incident.Category.NameStringTOPdesk incident's category name.
TOPdesk.Incident.Subcategory.IdStringTOPdesk incident's subcategory ID.
TOPdesk.Incident.Subcategory.NameStringTOPdesk incident's subcategory name.
TOPdesk.Incident.CallType.IdStringTOPdesk incident's call type ID.
TOPdesk.Incident.CallType.NameStringTOPdesk incident's call type name.
TOPdesk.Incident.EntryType.IdStringTOPdesk incident's entry type ID.
TOPdesk.Incident.EntryType.NameStringTOPdesk incident's entry type name.
TOPdesk.Incident.Object.IdStringTOPdesk incident's object ID.
TOPdesk.Incident.Object.NameStringTOPdesk incident's object name.
TOPdesk.Incident.Object.Type.IdStringTOPdesk incident's object type ID.
TOPdesk.Incident.Object.Type.NameStringTOPdesk incident's object type name.
TOPdesk.Incident.Object.Make.IdStringTOPdesk incident's object make ID.
TOPdesk.Incident.Object.Make.NameStringTOPdesk incident's object make name.
TOPdesk.Incident.Object.Model.IdStringTOPdesk incident's object model ID.
TOPdesk.Incident.Object.Model.NameStringTOPdesk incident's object model name.
TOPdesk.Incident.Object.Branch.IdStringTOPdesk incident's object branch ID.
TOPdesk.Incident.Object.Branch.NameStringTOPdesk incident's object branch name.
TOPdesk.Incident.Object.Location.IdStringTOPdesk incident's object location ID.
TOPdesk.Incident.Object.Location.NameStringTOPdesk incident's object location name.
TOPdesk.Incident.Object.SpecificationStringTOPdesk incident's object specification.
TOPdesk.Incident.Object.SerialNumberStringTOPdesk incident's object serial number.
TOPdesk.Incident.Asset.IdStringTOPdesk incident's asset ID.
TOPdesk.Incident.Branch.ClientReferenceNumberStringTOPdesk incident's branch client reference number.
TOPdesk.Incident.Branch.TimeZoneStringTOPdesk incident's branch timezone.
TOPdesk.Incident.Branch.ExtraAUnknownTOPdesk incident's branch extra A.
TOPdesk.Incident.Branch.ExtraBUnknownTOPdesk incident's branch extra B.
TOPdesk.Incident.Branch.IdStringTOPdesk incident's branch ID.
TOPdesk.Incident.Branch.NameStringTOPdesk incident's branch name.
TOPdesk.Incident.Location.IdStringTOPdesk incident's location ID.
TOPdesk.Incident.Location.Branch.ClientReferenceNumberStringTOPdesk incident's location branch client reference number.
TOPdesk.Incident.Location.Branch.TimeZoneStringTOPdesk incident's location branch timezone.
TOPdesk.Incident.Location.Branch.ExtraAUnknownTOPdesk incident's location branch extra A.
TOPdesk.Incident.Location.Branch.ExtraBUnknownTOPdesk incident's location branch extra B.
TOPdesk.Incident.Location.Branch.IdStringTOPdesk incident's location branch ID.
TOPdesk.Incident.Location.Branch.NameStringTOPdesk incident's location branch name.
TOPdesk.Incident.Location.NameStringTOPdesk incident's location name.
TOPdesk.Incident.Location.RoomStringTOPdesk incident's location room.
TOPdesk.Incident.Impact.IdStringTOPdesk incident's impact ID.
TOPdesk.Incident.Impact.NameStringTOPdesk incident's impact name.
TOPdesk.Incident.Urgency.IdStringTOPdesk incident's urgency ID.
TOPdesk.Incident.Urgency.NameStringTOPdesk incident's urgency name.
TOPdesk.Incident.Priority.IdStringTOPdesk incident's priority ID.
TOPdesk.Incident.Priority.NameStringTOPdesk incident's priority name.
TOPdesk.Incident.Duration.IdStringTOPdesk incident's duration ID.
TOPdesk.Incident.Duration.NameStringTOPdesk incident's duration name.
TOPdesk.Incident.TargetDateDateTOPdesk incident's target date.
TOPdesk.Incident.Sla.IdStringTOPdesk incident's sla ID.
TOPdesk.Incident.OnHoldBooleanTOPdesk incident's on hold.
TOPdesk.Incident.OnHoldDateUnknownTOPdesk incident's on hold date.
TOPdesk.Incident.OnHoldDurationNumberTOPdesk incident's on hold duration.
TOPdesk.Incident.FeedbackMessageUnknownTOPdesk incident's feedback message.
TOPdesk.Incident.FeedbackRatingUnknownTOPdesk incident's feedback rating.
TOPdesk.Incident.Operator.IdStringTOPdesk incident's operator ID.
TOPdesk.Incident.Operator.StatusStringTOPdesk incident's operator status.
TOPdesk.Incident.Operator.NameStringTOPdesk incident's operator name.
TOPdesk.Incident.OperatorGroup.IdStringTOPdesk incident's operator group ID.
TOPdesk.Incident.OperatorGroup.NameStringTOPdesk incident's operator group name.
TOPdesk.Incident.Supplier.IdStringTOPdesk incident's supplier ID.
TOPdesk.Incident.Supplier.NameStringTOPdesk incident's supplier name.
TOPdesk.Incident.Supplier.ForFirstLineBooleanTOPdesk incident's supplier for first line.
TOPdesk.Incident.Supplier.ForSecondLineBooleanTOPdesk incident's supplier for second line.
TOPdesk.Incident.ProcessingStatus.IdStringTOPdesk incident's processing status ID.
TOPdesk.Incident.ProcessingStatus.NameStringTOPdesk incident's processing status name.
TOPdesk.Incident.CompletedBooleanTOPdesk incident's completed.
TOPdesk.Incident.CompletedDateUnknownTOPdesk incident's completed date.
TOPdesk.Incident.ClosedBooleanTOPdesk incident's closed.
TOPdesk.Incident.ClosedDateUnknownTOPdesk incident's closed date.
TOPdesk.Incident.ClosureCode.IdStringTOPdesk incident's closure code ID.
TOPdesk.Incident.ClosureCode.NameStringTOPdesk incident's closure code name.
TOPdesk.Incident.TimeSpentNumberTOPdesk incident's time spent.
TOPdesk.Incident.TimeSpentFirstLineNumberTOPdesk incident's time spent first line
TOPdesk.Incident.TimeSpentSecondLineAndPartialsNumberTOPdesk incident's time spent second line and partials.
TOPdesk.Incident.CostsNumberTOPdesk incident's costs.
TOPdesk.Incident.EscalationStatusStringTOPdesk incident's escalation status.
TOPdesk.Incident.EscalationReason.IdStringTOPdesk incident's escalation reason ID.
TOPdesk.Incident.EscalationReason.NameStringTOPdesk incident's escalation reason name.
TOPdesk.Incident.EscalationOperator.IdStringTOPdesk incident's escalation operator ID.
TOPdesk.Incident.EscalationOperator.NameStringTOPdesk incident's escalation operator name.
TOPdesk.Incident.CallDateDateTOPdesk incident's call date.
TOPdesk.Incident.Creator.IdStringTOPdesk incident's creator ID.
TOPdesk.Incident.Creator.NameStringTOPdesk incident's creator name.
TOPdesk.Incident.CreationDateDateTOPdesk incident's creation date.
TOPdesk.Incident.Modifier.IdStringTOPdesk incident's modifier ID.
TOPdesk.Incident.Modifier.NameStringTOPdesk incident's modifier name.
TOPdesk.Incident.ModificationDateDateTOPdesk incident's modification date.
TOPdesk.Incident.MajorCallBooleanTOPdesk incident's major call.
TOPdesk.Incident.MajorCallObject.NameStringTOPdesk incident's Major call object name.
TOPdesk.Incident.MajorCallObject.IdStringTOPdesk incident's major call object ID.
TOPdesk.Incident.MajorCallObject.StatusNumberTOPdesk incident's major call object status.
TOPdesk.Incident.MajorCallObject.MajorIncidentBooleanTOPdesk incident's major call object major incident.
TOPdesk.Incident.PublishToSsdBooleanTOPdesk incident's publish to SSD.
TOPdesk.Incident.MonitoredBooleanTOPdesk incident's monitored.
TOPdesk.Incident.ExpectedTimeSpentNumberTOPdesk incident's expected time spent.
TOPdesk.Incident.MainIncidentUnknownTOPdesk incident's main incident.
TOPdesk.Incident.PartialIncidents.LinkStringTOPdesk incident's partial incidents link.
TOPdesk.Incident.OptionalFields1.Boolean1BooleanTOPdesk incident's optional fields1 boolean1.
TOPdesk.Incident.OptionalFields1.Boolean2BooleanTOPdesk incident's optional fields1 boolean2.
TOPdesk.Incident.OptionalFields1.Boolean3BooleanTOPdesk incident's optional fields1 boolean3.
TOPdesk.Incident.OptionalFields1.Boolean4BooleanTOPdesk incident's optional fields1 boolean4.
TOPdesk.Incident.OptionalFields1.Boolean5BooleanTOPdesk incident's optional fields1 boolean5.
TOPdesk.Incident.OptionalFields1.Number1NumberTOPdesk incident's optional fields1 number1.
TOPdesk.Incident.OptionalFields1.Number2NumberTOPdesk incident's optional fields1 number2.
TOPdesk.Incident.OptionalFields1.Number3NumberTOPdesk incident's optional fields1 number3.
TOPdesk.Incident.OptionalFields1.Number4NumberTOPdesk incident's optional fields1 number4.
TOPdesk.Incident.OptionalFields1.Number5NumberTOPdesk incident's optional fields1 number5.
TOPdesk.Incident.OptionalFields1.Date1DateTOPdesk incident's optional fields1 date1.
TOPdesk.Incident.OptionalFields1.Date2DateTOPdesk incident's optional fields1 date2.
TOPdesk.Incident.OptionalFields1.Date3DateTOPdesk incident's optional fields1 date3.
TOPdesk.Incident.OptionalFields1.Date4DateTOPdesk incident's optional fields1 date4.
TOPdesk.Incident.OptionalFields1.Date5DateTOPdesk incident's optional fields1 date5.
TOPdesk.Incident.OptionalFields1.Text1StringTOPdesk incident's optional fields1 text1.
TOPdesk.Incident.OptionalFields1.Text2StringTOPdesk incident's optional fields1 text2.
TOPdesk.Incident.OptionalFields1.Text3StringTOPdesk incident's optional fields1 text3.
TOPdesk.Incident.OptionalFields1.Text4StringTOPdesk incident's optional fields1 text4.
TOPdesk.Incident.OptionalFields1.Text5StringTOPdesk incident's optional fields1 text5.
TOPdesk.Incident.OptionalFields1.Memo1StringTOPdesk incident's optional fields1 memo1.
TOPdesk.Incident.OptionalFields1.Memo2StringTOPdesk incident's optional fields1 memo2.
TOPdesk.Incident.OptionalFields1.Memo3StringTOPdesk incident's optional fields1 memo3.
TOPdesk.Incident.OptionalFields1.Memo4StringTOPdesk incident's optional fields1 memo4.
TOPdesk.Incident.OptionalFields1.Memo5StringTOPdesk incident's optional fields1 memo5.
TOPdesk.Incident.OptionalFields1.Searchlist1.IdStringTOPdesk incident's optional fields1 searchlist1 ID.
TOPdesk.Incident.OptionalFields1.Searchlist1.NameStringTOPdesk incident's optional fields1 searchlist1 name.
TOPdesk.Incident.OptionalFields1.Searchlist2.IdStringTOPdesk incident's optional fields1 searchlist2 ID.
TOPdesk.Incident.OptionalFields1.Searchlist2.NameStringTOPdesk incident's optional fields1 searchlist2 name.
TOPdesk.Incident.OptionalFields1.Searchlist3.IdStringTOPdesk incident's optional fields1 searchlist3 ID.
TOPdesk.Incident.OptionalFields1.Searchlist3.NameStringTOPdesk incident's optional fields1 searchlist3 name.
TOPdesk.Incident.OptionalFields1.Searchlist4.IdStringTOPdesk incident's optional fields1 searchlist4 ID.
TOPdesk.Incident.OptionalFields1.Searchlist4.NameStringTOPdesk incident's optional fields1 searchlist4 name.
TOPdesk.Incident.OptionalFields1.Searchlist5.IdStringTOPdesk incident's optional fields1 searchlist5 ID.
TOPdesk.Incident.OptionalFields1.Searchlist5.NameStringTOPdesk incident's optional fields1 searchlist5 name.
TOPdesk.Incident.OptionalFields2.Boolean1BooleanTOPdesk incident's optional fields2 boolean1.
TOPdesk.Incident.OptionalFields2.Boolean2BooleanTOPdesk incident's optional fields2 boolean2.
TOPdesk.Incident.OptionalFields2.Boolean3BooleanTOPdesk incident's optional fields2 boolean3.
TOPdesk.Incident.OptionalFields2.Boolean4BooleanTOPdesk incident's optional fields2 boolean4.
TOPdesk.Incident.OptionalFields2.Boolean5BooleanTOPdesk incident's optional fields2 boolean5.
TOPdesk.Incident.OptionalFields2.Number1NumberTOPdesk incident's optional fields2 number1.
TOPdesk.Incident.OptionalFields2.Number2NumberTOPdesk incident's optional fields2 number2.
TOPdesk.Incident.OptionalFields2.Number3NumberTOPdesk incident's optional fields2 number3.
TOPdesk.Incident.OptionalFields2.Number4NumberTOPdesk incident's optional fields2 number4.
TOPdesk.Incident.OptionalFields2.Number5NumberTOPdesk incident's optional fields2 number5.
TOPdesk.Incident.OptionalFields2.Date1DateTOPdesk incident's optional fields2 date1.
TOPdesk.Incident.OptionalFields2.Date2DateTOPdesk incident's optional fields2 date2.
TOPdesk.Incident.OptionalFields2.Date3DateTOPdesk incident's optional fields2 date3.
TOPdesk.Incident.OptionalFields2.Date4DateTOPdesk incident's optional fields2 date4.
TOPdesk.Incident.OptionalFields2.Date5DateTOPdesk incident's optional fields2 date5.
TOPdesk.Incident.OptionalFields2.Text1StringTOPdesk incident's optional fields2 text1.
TOPdesk.Incident.OptionalFields2.Text2StringTOPdesk incident's optional fields2 text2.
TOPdesk.Incident.OptionalFields2.Text3StringTOPdesk incident's optional fields2.text3.
TOPdesk.Incident.OptionalFields2.Text4StringTOPdesk incident's optional fields2 text4.
TOPdesk.Incident.OptionalFields2.Text5StringTOPdesk incident's optional fields2 text5.
TOPdesk.Incident.OptionalFields2.Memo1StringTOPdesk incident's optional fields2 memo1.
TOPdesk.Incident.OptionalFields2.Memo2StringTOPdesk incident's optional fields2 memo2.
TOPdesk.Incident.OptionalFields2.Memo3StringTOPdesk incident's optional fields2 memo3.
TOPdesk.Incident.OptionalFields2.Memo4StringTOPdesk incident's optional fields2 memo4.
TOPdesk.Incident.OptionalFields2.Memo5StringTOPdesk incident's optional fields2 memo5.
TOPdesk.Incident.OptionalFields2.Searchlist1.IdStringTOPdesk incident's optional fields2 searchlist1 ID.
TOPdesk.Incident.OptionalFields2.Searchlist1.NameStringTOPdesk incident's optional fields2 searchlist1 name.
TOPdesk.Incident.OptionalFields2.Searchlist2.IdStringTOPdesk incident's optional fields2 searchlist2 ID.
TOPdesk.Incident.OptionalFields2.Searchlist2.NameStringTOPdesk incident's optional fields2 searchlist2 name.
TOPdesk.Incident.OptionalFields2.Searchlist3.IdStringTOPdesk incident's optional fields2 searchlist3 ID.
TOPdesk.Incident.OptionalFields2.Searchlist3.NameStringTOPdesk incident's optional fields2 searchlist3 name.
TOPdesk.Incident.OptionalFields2.Searchlist4.IdStringTOPdesk incident's optional fields2 searchlist4 ID.
TOPdesk.Incident.OptionalFields2.Searchlist4.NameStringTOPdesk incident's optional fields2 searchlist4 name.
TOPdesk.Incident.OptionalFields2.Searchlist5.IdStringTOPdesk incident's optional fields2 searchlist5 ID.
TOPdesk.Incident.OptionalFields2.Searchlist5.NameStringTOPdesk incident's optional fields2 searchlist5 name.
TOPdesk.Incident.ExternalLinks.IdStringTOPdesk incident's external links ID.
TOPdesk.Incident.ExternalLinks.TypeStringTOPdesk incident's external links type.
TOPdesk.Incident.ExternalLinks.DateDateTOPdesk incident's external links date.

Command Example#

!topdesk-incident-deescalate number=XSOAR-1337 deescalate_reason_id=some-deescalation-id-1

Context Example#

{
"TOPdesk": {
"Incident": [
{
"Action": "/tas/api/incidents/id/some-id/actions",
"Attachments": "/tas/api/incidents/id/some-id/attachments",
"BriefDescription": "some-updated-description",
"CallDate": "2021-03-24T08:15:13.867+0000",
"Caller": {
"DynamicName": "some-caller"
},
"Closed": false,
"Completed": false,
"CreationDate": "2021-03-24T08:15:13.867+0000",
"Creator": {
"Id": "some-id-1",
"Name": "Xsoar - Operator"
},
"ExternalNumber": "",
"Id": "some-id",
"MajorCall": false,
"ModificationDate": "2021-03-24T08:15:13.000+0000",
"Modifier": {
"Id": "some-id-1",
"Name": "Xsoar - Operator"
},
"Monitored": false,
"Number": "XSOAR-1337",
"OnHold": false,
"OptionalFields1": {
"Searchlist1": {
"Id": "some-id-3",
"Name": "Some Search Name"
},
"Searchlist3": {
"Id": "some-id-4",
"Name": "Some Other Search Name"
},
"Text1": "",
"Text2": "",
"Text3": "",
"Text4": "",
"Text5": ""
},
"OptionalFields2": {
"Text1": "",
"Text2": "",
"Text3": "",
"Text4": "",
"Text5": ""
},
"ProcessingStatus": {
"Id": "some-processing-status-id",
"Name": "Logged"
},
"PublishToSsd": false,
"Requests": "/tas/api/incidents/id/some-id/requests",
"Responded": false,
"Status": "firstLine"
}
]
}
}

Human Readable Output#

TOPdesk incidents#

IdNumberLineCallerNameStatus
some-idXSOAR-1337firstLinesome-callerLogged

topdesk-incident-archive#

Archive an incident in TOPdesk.

Permissions#

Operator: Incident write permission and archiving permission; Category/Branch/Operator filters apply;

Person: No access

Base Command#

topdesk-incident-archive

Input#

Argument NameDescriptionRequired
idThe incident ID. An ID or a number must be set. If both are set incident with relevant ID will be updated.Optional
number.The incident number. An ID or a number must be set. If both are set incident with relevant ID will be updated.Optional
archive_reason_idThe archiving reason ID.Required

Context Output#

PathTypeDescription
TOPdesk.Incident.IdStringTOPdesk incident's ID.
TOPdesk.Incident.StatusStringTOPdesk incident's status.
TOPdesk.Incident.NumberStringTOPdesk incident's number.
TOPdesk.Incident.RequestStringTOPdesk incident's request.
TOPdesk.Incident.RequestsStringTOPdesk incident's requests.
TOPdesk.Incident.ActionStringTOPdesk incident's action.
TOPdesk.Incident.AttachmentsStringTOPdesk incident's attachments.
TOPdesk.Incident.Caller.IdStringTOPdesk incident's caller ID.
TOPdesk.Incident.Caller.DynamicNameStringTOPdesk incident's caller dynamic name.
TOPdesk.Incident.Caller.Branch.ClientReferenceNumberStringTOPdesk incident's caller branch client reference number.
TOPdesk.Incident.Caller.Branch.TimeZoneStringTOPdesk incident's caller branch timezone.
TOPdesk.Incident.Caller.Branch.ExtraAUnknownTOPdesk incident's caller branch extra A.
TOPdesk.Incident.Caller.Branch.ExtraBUnknownTOPdesk incident's caller branch extra B.
TOPdesk.Incident.Caller.Branch.IdStringTOPdesk incident's caller branch ID.
TOPdesk.Incident.Caller.Branch.NameStringTOPdesk incident's caller branch name.
TOPdesk.Incident.CallerBranch.ClientReferenceNumberStringTOPdesk incident's caller branch client reference number.
TOPdesk.Incident.CallerBranch.TimeZoneStringTOPdesk incident's caller branch timezone.
TOPdesk.Incident.CallerBranch.ExtraAUnknownTOPdesk incident's caller branch extra A.
TOPdesk.Incident.CallerBranch.ExtraBUnknownTOPdesk incident's caller branch extra B.
TOPdesk.Incident.CallerBranch.IdStringTOPdesk incident's caller branch ID.
TOPdesk.Incident.CallerBranch.NameStringTOPdesk incident's caller branch name.
TOPdesk.Incident.BranchExtraFieldAUnknownTOPdesk incident's branch extra field A.
TOPdesk.Incident.BranchExtraFieldBUnknownTOPdesk incident's branch extra field B.
TOPdesk.Incident.BriefDescriptionStringTOPdesk incident's brief description.
TOPdesk.Incident.ExternalNumberStringTOPdesk incident's external number.
TOPdesk.Incident.Category.IdStringTOPdesk incident's category ID.
TOPdesk.Incident.Category.NameStringTOPdesk incident's category name.
TOPdesk.Incident.Subcategory.IdStringTOPdesk incident's subcategory ID.
TOPdesk.Incident.Subcategory.NameStringTOPdesk incident's subcategory name.
TOPdesk.Incident.CallType.IdStringTOPdesk incident's call type ID.
TOPdesk.Incident.CallType.NameStringTOPdesk incident's call type name.
TOPdesk.Incident.EntryType.IdStringTOPdesk incident's entry type ID.
TOPdesk.Incident.EntryType.NameStringTOPdesk incident's entry type name.
TOPdesk.Incident.Object.IdStringTOPdesk incident's object ID.
TOPdesk.Incident.Object.NameStringTOPdesk incident's object name.
TOPdesk.Incident.Object.Type.IdStringTOPdesk incident's object type ID.
TOPdesk.Incident.Object.Type.NameStringTOPdesk incident's object type name.
TOPdesk.Incident.Object.Make.IdStringTOPdesk incident's object make ID.
TOPdesk.Incident.Object.Make.NameStringTOPdesk incident's object make name.
TOPdesk.Incident.Object.Model.IdStringTOPdesk incident's object model ID.
TOPdesk.Incident.Object.Model.NameStringTOPdesk incident's object model name.
TOPdesk.Incident.Object.Branch.IdStringTOPdesk incident's object branch ID.
TOPdesk.Incident.Object.Branch.NameStringTOPdesk incident's object branch name.
TOPdesk.Incident.Object.Location.IdStringTOPdesk incident's object location ID.
TOPdesk.Incident.Object.Location.NameStringTOPdesk incident's object location name.
TOPdesk.Incident.Object.SpecificationStringTOPdesk incident's object specification.
TOPdesk.Incident.Object.SerialNumberStringTOPdesk incident's object serial number.
TOPdesk.Incident.Asset.IdStringTOPdesk incident's asset ID.
TOPdesk.Incident.Branch.ClientReferenceNumberStringTOPdesk incident's branch client reference number.
TOPdesk.Incident.Branch.TimeZoneStringTOPdesk incident's branch timezone.
TOPdesk.Incident.Branch.ExtraAUnknownTOPdesk incident's branch extra A.
TOPdesk.Incident.Branch.ExtraBUnknownTOPdesk incident's branch extra B.
TOPdesk.Incident.Branch.IdStringTOPdesk incident's branch ID.
TOPdesk.Incident.Branch.NameStringTOPdesk incident's branch name.
TOPdesk.Incident.Location.IdStringTOPdesk incident's location ID.
TOPdesk.Incident.Location.Branch.ClientReferenceNumberStringTOPdesk incident's location branch client reference number.
TOPdesk.Incident.Location.Branch.TimeZoneStringTOPdesk incident's location branch timezone.
TOPdesk.Incident.Location.Branch.ExtraAUnknownTOPdesk incident's location branch extra A.
TOPdesk.Incident.Location.Branch.ExtraBUnknownTOPdesk incident's location branch extra B.
TOPdesk.Incident.Location.Branch.IdStringTOPdesk incident's location branch ID.
TOPdesk.Incident.Location.Branch.NameStringTOPdesk incident's location branch name.
TOPdesk.Incident.Location.NameStringTOPdesk incident's location name.
TOPdesk.Incident.Location.RoomStringTOPdesk incident's location room.
TOPdesk.Incident.Impact.IdStringTOPdesk incident's impact ID.
TOPdesk.Incident.Impact.NameStringTOPdesk incident's impact name.
TOPdesk.Incident.Urgency.IdStringTOPdesk incident's urgency ID.
TOPdesk.Incident.Urgency.NameStringTOPdesk incident's urgency name.
TOPdesk.Incident.Priority.IdStringTOPdesk incident's priority ID.
TOPdesk.Incident.Priority.NameStringTOPdesk incident's priority name.
TOPdesk.Incident.Duration.IdStringTOPdesk incident's duration ID.
TOPdesk.Incident.Duration.NameStringTOPdesk incident's duration name.
TOPdesk.Incident.TargetDateDateTOPdesk incident's target date.
TOPdesk.Incident.Sla.IdStringTOPdesk incident's sla ID.
TOPdesk.Incident.OnHoldBooleanTOPdesk incident's on hold.
TOPdesk.Incident.OnHoldDateUnknownTOPdesk incident's on hold date.
TOPdesk.Incident.OnHoldDurationNumberTOPdesk incident's on hold duration.
TOPdesk.Incident.FeedbackMessageUnknownTOPdesk incident's feedback message.
TOPdesk.Incident.FeedbackRatingUnknownTOPdesk incident's feedback rating.
TOPdesk.Incident.Operator.IdStringTOPdesk incident's operator ID.
TOPdesk.Incident.Operator.StatusStringTOPdesk incident's operator status.
TOPdesk.Incident.Operator.NameStringTOPdesk incident's operator name.
TOPdesk.Incident.OperatorGroup.IdStringTOPdesk incident's operator group ID.
TOPdesk.Incident.OperatorGroup.NameStringTOPdesk incident's operator group name.
TOPdesk.Incident.Supplier.IdStringTOPdesk incident's supplier ID.
TOPdesk.Incident.Supplier.NameStringTOPdesk incident's supplier name.
TOPdesk.Incident.Supplier.ForFirstLineBooleanTOPdesk incident's supplier for first line.
TOPdesk.Incident.Supplier.ForSecondLineBooleanTOPdesk incident's supplier for second line.
TOPdesk.Incident.ProcessingStatus.IdStringTOPdesk incident's processing status ID.
TOPdesk.Incident.ProcessingStatus.NameStringTOPdesk incident's processing status name.
TOPdesk.Incident.CompletedBooleanTOPdesk incident's completed.
TOPdesk.Incident.CompletedDateUnknownTOPdesk incident's completed date.
TOPdesk.Incident.ClosedBooleanTOPdesk incident's closed.
TOPdesk.Incident.ClosedDateUnknownTOPdesk incident's closed date.
TOPdesk.Incident.ClosureCode.IdStringTOPdesk incident's closure code ID.
TOPdesk.Incident.ClosureCode.NameStringTOPdesk incident's closure code name.
TOPdesk.Incident.TimeSpentNumberTOPdesk incident's time spent.
TOPdesk.Incident.TimeSpentFirstLineNumberTOPdesk incident's time spent first line
TOPdesk.Incident.TimeSpentSecondLineAndPartialsNumberTOPdesk incident's time spent second line and partials.
TOPdesk.Incident.CostsNumberTOPdesk incident's costs.
TOPdesk.Incident.EscalationStatusStringTOPdesk incident's escalation status.
TOPdesk.Incident.EscalationReason.IdStringTOPdesk incident's escalation reason ID.
TOPdesk.Incident.EscalationReason.NameStringTOPdesk incident's escalation reason name.
TOPdesk.Incident.EscalationOperator.IdStringTOPdesk incident's escalation operator ID.
TOPdesk.Incident.EscalationOperator.NameStringTOPdesk incident's escalation operator name.
TOPdesk.Incident.CallDateDateTOPdesk incident's call date.
TOPdesk.Incident.Creator.IdStringTOPdesk incident's creator ID.
TOPdesk.Incident.Creator.NameStringTOPdesk incident's creator name.
TOPdesk.Incident.CreationDateDateTOPdesk incident's creation date.
TOPdesk.Incident.Modifier.IdStringTOPdesk incident's modifier ID.
TOPdesk.Incident.Modifier.NameStringTOPdesk incident's modifier name.
TOPdesk.Incident.ModificationDateDateTOPdesk incident's modification date.
TOPdesk.Incident.MajorCallBooleanTOPdesk incident's major call.
TOPdesk.Incident.MajorCallObject.NameStringTOPdesk incident's Major call object name.
TOPdesk.Incident.MajorCallObject.IdStringTOPdesk incident's major call object ID.
TOPdesk.Incident.MajorCallObject.StatusNumberTOPdesk incident's major call object status.
TOPdesk.Incident.MajorCallObject.MajorIncidentBooleanTOPdesk incident's major call object major incident.
TOPdesk.Incident.PublishToSsdBooleanTOPdesk incident's publish to SSD.
TOPdesk.Incident.MonitoredBooleanTOPdesk incident's monitored.
TOPdesk.Incident.ExpectedTimeSpentNumberTOPdesk incident's expected time spent.
TOPdesk.Incident.MainIncidentUnknownTOPdesk incident's main incident.
TOPdesk.Incident.PartialIncidents.LinkStringTOPdesk incident's partial incidents link.
TOPdesk.Incident.OptionalFields1.Boolean1BooleanTOPdesk incident's optional fields1 boolean1.
TOPdesk.Incident.OptionalFields1.Boolean2BooleanTOPdesk incident's optional fields1 boolean2.
TOPdesk.Incident.OptionalFields1.Boolean3BooleanTOPdesk incident's optional fields1 boolean3.
TOPdesk.Incident.OptionalFields1.Boolean4BooleanTOPdesk incident's optional fields1 boolean4.
TOPdesk.Incident.OptionalFields1.Boolean5BooleanTOPdesk incident's optional fields1 boolean5.
TOPdesk.Incident.OptionalFields1.Number1NumberTOPdesk incident's optional fields1 number1.
TOPdesk.Incident.OptionalFields1.Number2NumberTOPdesk incident's optional fields1 number2.
TOPdesk.Incident.OptionalFields1.Number3NumberTOPdesk incident's optional fields1 number3.
TOPdesk.Incident.OptionalFields1.Number4NumberTOPdesk incident's optional fields1 number4.
TOPdesk.Incident.OptionalFields1.Number5NumberTOPdesk incident's optional fields1 number5.
TOPdesk.Incident.OptionalFields1.Date1DateTOPdesk incident's optional fields1 date1.
TOPdesk.Incident.OptionalFields1.Date2DateTOPdesk incident's optional fields1 date2.
TOPdesk.Incident.OptionalFields1.Date3DateTOPdesk incident's optional fields1 date3.
TOPdesk.Incident.OptionalFields1.Date4DateTOPdesk incident's optional fields1 date4.
TOPdesk.Incident.OptionalFields1.Date5DateTOPdesk incident's optional fields1 date5.
TOPdesk.Incident.OptionalFields1.Text1StringTOPdesk incident's optional fields1 text1.
TOPdesk.Incident.OptionalFields1.Text2StringTOPdesk incident's optional fields1 text2.
TOPdesk.Incident.OptionalFields1.Text3StringTOPdesk incident's optional fields1 text3.
TOPdesk.Incident.OptionalFields1.Text4StringTOPdesk incident's optional fields1 text4.
TOPdesk.Incident.OptionalFields1.Text5StringTOPdesk incident's optional fields1 text5.
TOPdesk.Incident.OptionalFields1.Memo1StringTOPdesk incident's optional fields1 memo1.
TOPdesk.Incident.OptionalFields1.Memo2StringTOPdesk incident's optional fields1 memo2.
TOPdesk.Incident.OptionalFields1.Memo3StringTOPdesk incident's optional fields1 memo3.
TOPdesk.Incident.OptionalFields1.Memo4StringTOPdesk incident's optional fields1 memo4.
TOPdesk.Incident.OptionalFields1.Memo5StringTOPdesk incident's optional fields1 memo5.
TOPdesk.Incident.OptionalFields1.Searchlist1.IdStringTOPdesk incident's optional fields1 searchlist1 ID.
TOPdesk.Incident.OptionalFields1.Searchlist1.NameStringTOPdesk incident's optional fields1 searchlist1 name.
TOPdesk.Incident.OptionalFields1.Searchlist2.IdStringTOPdesk incident's optional fields1 searchlist2 ID.
TOPdesk.Incident.OptionalFields1.Searchlist2.NameStringTOPdesk incident's optional fields1 searchlist2 name.
TOPdesk.Incident.OptionalFields1.Searchlist3.IdStringTOPdesk incident's optional fields1 searchlist3 ID.
TOPdesk.Incident.OptionalFields1.Searchlist3.NameStringTOPdesk incident's optional fields1 searchlist3 name.
TOPdesk.Incident.OptionalFields1.Searchlist4.IdStringTOPdesk incident's optional fields1 searchlist4 ID.
TOPdesk.Incident.OptionalFields1.Searchlist4.NameStringTOPdesk incident's optional fields1 searchlist4 name.
TOPdesk.Incident.OptionalFields1.Searchlist5.IdStringTOPdesk incident's optional fields1 searchlist5 ID.
TOPdesk.Incident.OptionalFields1.Searchlist5.NameStringTOPdesk incident's optional fields1 searchlist5 name.
TOPdesk.Incident.OptionalFields2.Boolean1BooleanTOPdesk incident's optional fields2 boolean1.
TOPdesk.Incident.OptionalFields2.Boolean2BooleanTOPdesk incident's optional fields2 boolean2.
TOPdesk.Incident.OptionalFields2.Boolean3BooleanTOPdesk incident's optional fields2 boolean3.
TOPdesk.Incident.OptionalFields2.Boolean4BooleanTOPdesk incident's optional fields2 boolean4.
TOPdesk.Incident.OptionalFields2.Boolean5BooleanTOPdesk incident's optional fields2 boolean5.
TOPdesk.Incident.OptionalFields2.Number1NumberTOPdesk incident's optional fields2 number1.
TOPdesk.Incident.OptionalFields2.Number2NumberTOPdesk incident's optional fields2 number2.
TOPdesk.Incident.OptionalFields2.Number3NumberTOPdesk incident's optional fields2 number3.
TOPdesk.Incident.OptionalFields2.Number4NumberTOPdesk incident's optional fields2 number4.
TOPdesk.Incident.OptionalFields2.Number5NumberTOPdesk incident's optional fields2 number5.
TOPdesk.Incident.OptionalFields2.Date1DateTOPdesk incident's optional fields2 date1.
TOPdesk.Incident.OptionalFields2.Date2DateTOPdesk incident's optional fields2 date2.
TOPdesk.Incident.OptionalFields2.Date3DateTOPdesk incident's optional fields2 date3.
TOPdesk.Incident.OptionalFields2.Date4DateTOPdesk incident's optional fields2 date4.
TOPdesk.Incident.OptionalFields2.Date5DateTOPdesk incident's optional fields2 date5.
TOPdesk.Incident.OptionalFields2.Text1StringTOPdesk incident's optional fields2 text1.
TOPdesk.Incident.OptionalFields2.Text2StringTOPdesk incident's optional fields2 text2.
TOPdesk.Incident.OptionalFields2.Text3StringTOPdesk incident's optional fields2.text3.
TOPdesk.Incident.OptionalFields2.Text4StringTOPdesk incident's optional fields2 text4.
TOPdesk.Incident.OptionalFields2.Text5StringTOPdesk incident's optional fields2 text5.
TOPdesk.Incident.OptionalFields2.Memo1StringTOPdesk incident's optional fields2 memo1.
TOPdesk.Incident.OptionalFields2.Memo2StringTOPdesk incident's optional fields2 memo2.
TOPdesk.Incident.OptionalFields2.Memo3StringTOPdesk incident's optional fields2 memo3.
TOPdesk.Incident.OptionalFields2.Memo4StringTOPdesk incident's optional fields2 memo4.
TOPdesk.Incident.OptionalFields2.Memo5StringTOPdesk incident's optional fields2 memo5.
TOPdesk.Incident.OptionalFields2.Searchlist1.IdStringTOPdesk incident's optional fields2 searchlist1 ID.
TOPdesk.Incident.OptionalFields2.Searchlist1.NameStringTOPdesk incident's optional fields2 searchlist1 name.
TOPdesk.Incident.OptionalFields2.Searchlist2.IdStringTOPdesk incident's optional fields2 searchlist2 ID.
TOPdesk.Incident.OptionalFields2.Searchlist2.NameStringTOPdesk incident's optional fields2 searchlist2 name.
TOPdesk.Incident.OptionalFields2.Searchlist3.IdStringTOPdesk incident's optional fields2 searchlist3 ID.
TOPdesk.Incident.OptionalFields2.Searchlist3.NameStringTOPdesk incident's optional fields2 searchlist3 name.
TOPdesk.Incident.OptionalFields2.Searchlist4.IdStringTOPdesk incident's optional fields2 searchlist4 ID.
TOPdesk.Incident.OptionalFields2.Searchlist4.NameStringTOPdesk incident's optional fields2 searchlist4 name.
TOPdesk.Incident.OptionalFields2.Searchlist5.IdStringTOPdesk incident's optional fields2 searchlist5 ID.
TOPdesk.Incident.OptionalFields2.Searchlist5.NameStringTOPdesk incident's optional fields2 searchlist5 name.
TOPdesk.Incident.ExternalLinks.IdStringTOPdesk incident's external links ID.
TOPdesk.Incident.ExternalLinks.TypeStringTOPdesk incident's external links type.
TOPdesk.Incident.ExternalLinks.DateDateTOPdesk incident's external links date.

Command Example#

!topdesk-incident-archive archive_reason_id=some-reason-id-1 number=XSOAR-1337

Context Example#

{
"TOPdesk": {
"Incident": {
"Action": "/tas/api/incidents/id/some-id/actions",
"ArchivingReason": {
"Id": "some-reason-id-1",
"Name": "No longer valid"
},
"Attachments": "/tas/api/incidents/id/some-id/attachments",
"BriefDescription": "",
"CallDate": "2021-03-21T17:38:03.007+0000",
"Caller": {
"Branch": {
"ClientReferenceNumber": null,
"ExtraA": null,
"ExtraB": null,
"Id": null,
"Name": "",
"TimeZone": null
},
"DynamicName": "xsoar_test"
},
"Closed": false,
"Completed": false,
"CreationDate": "2021-03-21T17:38:03.007+0000",
"Creator": {
"Id": "some-operator-id",
"Name": "Xsoar - Operator"
},
"ExternalNumber": "",
"Id": "some-id",
"MajorCall": false,
"ModificationDate": "2021-03-24T08:15:06.000+0000",
"Modifier": {
"Id": "some-operator-id",
"Name": "Xsoar - Operator"
},
"Monitored": false,
"Number": "XSOAR-1337",
"OnHold": false,
"OptionalFields1": {
"Searchlist1": {
"Id": "some-id-33",
"Name": "Searchlist 1"
},
"Searchlist3": {
"Id": "some-id-34",
"Name": "Searchlist 3"
},
"Text1": "",
"Text2": "",
"Text3": "",
"Text4": "",
"Text5": ""
},
"OptionalFields2": {
"Text1": "",
"Text2": "",
"Text3": "",
"Text4": "",
"Text5": ""
},
"ProcessingStatus": {
"Id": "some-processing-id",
"Name": "Logged"
},
"PublishToSsd": false,
"Requests": "/tas/api/incidents/id/some-id/requests",
"Responded": false,
"Status": "firstLineArchived"
}
}
}

Human Readable Output#

TOPdesk incidents#

IdNumberLineCallerNameStatus
some-idXSOAR-1337firstLineArchivedxsoar_testLogged

topdesk-incident-unarchive#

Unarchive an incident in TOPdesk.

Permissions#

Operator: Incident write permission and archiving permission; Category/Branch/Operator filters apply;

Person: No access

Base Command#

topdesk-incident-unarchive

Input#

Argument NameDescriptionRequired
idThe incident ID. An ID or a number must be set. If both are set incident with relevant ID will be updated.Optional
number.The incident number. An ID or a number must be set. If both are set incident with relevant ID will be updated.Optional

Context Output#

PathTypeDescription
TOPdesk.Incident.IdStringTOPdesk incident's ID.
TOPdesk.Incident.StatusStringTOPdesk incident's status.
TOPdesk.Incident.NumberStringTOPdesk incident's number.
TOPdesk.Incident.RequestStringTOPdesk incident's request.
TOPdesk.Incident.RequestsStringTOPdesk incident's requests.
TOPdesk.Incident.ActionStringTOPdesk incident's action.
TOPdesk.Incident.AttachmentsStringTOPdesk incident's attachments.
TOPdesk.Incident.Caller.IdStringTOPdesk incident's caller ID.
TOPdesk.Incident.Caller.DynamicNameStringTOPdesk incident's caller dynamic name.
TOPdesk.Incident.Caller.Branch.ClientReferenceNumberStringTOPdesk incident's caller branch client reference number.
TOPdesk.Incident.Caller.Branch.TimeZoneStringTOPdesk incident's caller branch timezone.
TOPdesk.Incident.Caller.Branch.ExtraAUnknownTOPdesk incident's caller branch extra A.
TOPdesk.Incident.Caller.Branch.ExtraBUnknownTOPdesk incident's caller branch extra B.
TOPdesk.Incident.Caller.Branch.IdStringTOPdesk incident's caller branch ID.
TOPdesk.Incident.Caller.Branch.NameStringTOPdesk incident's caller branch name.
TOPdesk.Incident.CallerBranch.ClientReferenceNumberStringTOPdesk incident's caller branch client reference number.
TOPdesk.Incident.CallerBranch.TimeZoneStringTOPdesk incident's caller branch timezone.
TOPdesk.Incident.CallerBranch.ExtraAUnknownTOPdesk incident's caller branch extra A.
TOPdesk.Incident.CallerBranch.ExtraBUnknownTOPdesk incident's caller branch extra B.
TOPdesk.Incident.CallerBranch.IdStringTOPdesk incident's caller branch ID.
TOPdesk.Incident.CallerBranch.NameStringTOPdesk incident's caller branch name.
TOPdesk.Incident.BranchExtraFieldAUnknownTOPdesk incident's branch extra field A.
TOPdesk.Incident.BranchExtraFieldBUnknownTOPdesk incident's branch extra field B.
TOPdesk.Incident.BriefDescriptionStringTOPdesk incident's brief description.
TOPdesk.Incident.ExternalNumberStringTOPdesk incident's external number.
TOPdesk.Incident.Category.IdStringTOPdesk incident's category ID.
TOPdesk.Incident.Category.NameStringTOPdesk incident's category name.
TOPdesk.Incident.Subcategory.IdStringTOPdesk incident's subcategory ID.
TOPdesk.Incident.Subcategory.NameStringTOPdesk incident's subcategory name.
TOPdesk.Incident.CallType.IdStringTOPdesk incident's call type ID.
TOPdesk.Incident.CallType.NameStringTOPdesk incident's call type name.
TOPdesk.Incident.EntryType.IdStringTOPdesk incident's entry type ID.
TOPdesk.Incident.EntryType.NameStringTOPdesk incident's entry type name.
TOPdesk.Incident.Object.IdStringTOPdesk incident's object ID.
TOPdesk.Incident.Object.NameStringTOPdesk incident's object name.
TOPdesk.Incident.Object.Type.IdStringTOPdesk incident's object type ID.
TOPdesk.Incident.Object.Type.NameStringTOPdesk incident's object type name.
TOPdesk.Incident.Object.Make.IdStringTOPdesk incident's object make ID.
TOPdesk.Incident.Object.Make.NameStringTOPdesk incident's object make name.
TOPdesk.Incident.Object.Model.IdStringTOPdesk incident's object model ID.
TOPdesk.Incident.Object.Model.NameStringTOPdesk incident's object model name.
TOPdesk.Incident.Object.Branch.IdStringTOPdesk incident's object branch ID.
TOPdesk.Incident.Object.Branch.NameStringTOPdesk incident's object branch name.
TOPdesk.Incident.Object.Location.IdStringTOPdesk incident's object location ID.
TOPdesk.Incident.Object.Location.NameStringTOPdesk incident's object location name.
TOPdesk.Incident.Object.SpecificationStringTOPdesk incident's object specification.
TOPdesk.Incident.Object.SerialNumberStringTOPdesk incident's object serial number.
TOPdesk.Incident.Asset.IdStringTOPdesk incident's asset ID.
TOPdesk.Incident.Branch.ClientReferenceNumberStringTOPdesk incident's branch client reference number.
TOPdesk.Incident.Branch.TimeZoneStringTOPdesk incident's branch timezone.
TOPdesk.Incident.Branch.ExtraAUnknownTOPdesk incident's branch extra A.
TOPdesk.Incident.Branch.ExtraBUnknownTOPdesk incident's branch extra B.
TOPdesk.Incident.Branch.IdStringTOPdesk incident's branch ID.
TOPdesk.Incident.Branch.NameStringTOPdesk incident's branch name.
TOPdesk.Incident.Location.IdStringTOPdesk incident's location ID.
TOPdesk.Incident.Location.Branch.ClientReferenceNumberStringTOPdesk incident's location branch client reference number.
TOPdesk.Incident.Location.Branch.TimeZoneStringTOPdesk incident's location branch timezone.
TOPdesk.Incident.Location.Branch.ExtraAUnknownTOPdesk incident's location branch extra A.
TOPdesk.Incident.Location.Branch.ExtraBUnknownTOPdesk incident's location branch extra B.
TOPdesk.Incident.Location.Branch.IdStringTOPdesk incident's location branch ID.
TOPdesk.Incident.Location.Branch.NameStringTOPdesk incident's location branch name.
TOPdesk.Incident.Location.NameStringTOPdesk incident's location name.
TOPdesk.Incident.Location.RoomStringTOPdesk incident's location room.
TOPdesk.Incident.Impact.IdStringTOPdesk incident's impact ID.
TOPdesk.Incident.Impact.NameStringTOPdesk incident's impact name.
TOPdesk.Incident.Urgency.IdStringTOPdesk incident's urgency ID.
TOPdesk.Incident.Urgency.NameStringTOPdesk incident's urgency name.
TOPdesk.Incident.Priority.IdStringTOPdesk incident's priority ID.
TOPdesk.Incident.Priority.NameStringTOPdesk incident's priority name.
TOPdesk.Incident.Duration.IdStringTOPdesk incident's duration ID.
TOPdesk.Incident.Duration.NameStringTOPdesk incident's duration name.
TOPdesk.Incident.TargetDateDateTOPdesk incident's target date.
TOPdesk.Incident.Sla.IdStringTOPdesk incident's sla ID.
TOPdesk.Incident.OnHoldBooleanTOPdesk incident's on hold.
TOPdesk.Incident.OnHoldDateUnknownTOPdesk incident's on hold date.
TOPdesk.Incident.OnHoldDurationNumberTOPdesk incident's on hold duration.
TOPdesk.Incident.FeedbackMessageUnknownTOPdesk incident's feedback message.
TOPdesk.Incident.FeedbackRatingUnknownTOPdesk incident's feedback rating.
TOPdesk.Incident.Operator.IdStringTOPdesk incident's operator ID.
TOPdesk.Incident.Operator.StatusStringTOPdesk incident's operator status.
TOPdesk.Incident.Operator.NameStringTOPdesk incident's operator name.
TOPdesk.Incident.OperatorGroup.IdStringTOPdesk incident's operator group ID.
TOPdesk.Incident.OperatorGroup.NameStringTOPdesk incident's operator group name.
TOPdesk.Incident.Supplier.IdStringTOPdesk incident's supplier ID.
TOPdesk.Incident.Supplier.NameStringTOPdesk incident's supplier name.
TOPdesk.Incident.Supplier.ForFirstLineBooleanTOPdesk incident's supplier for first line.
TOPdesk.Incident.Supplier.ForSecondLineBooleanTOPdesk incident's supplier for second line.
TOPdesk.Incident.ProcessingStatus.IdStringTOPdesk incident's processing status ID.
TOPdesk.Incident.ProcessingStatus.NameStringTOPdesk incident's processing status name.
TOPdesk.Incident.CompletedBooleanTOPdesk incident's completed.
TOPdesk.Incident.CompletedDateUnknownTOPdesk incident's completed date.
TOPdesk.Incident.ClosedBooleanTOPdesk incident's closed.
TOPdesk.Incident.ClosedDateUnknownTOPdesk incident's closed date.
TOPdesk.Incident.ClosureCode.IdStringTOPdesk incident's closure code ID.
TOPdesk.Incident.ClosureCode.NameStringTOPdesk incident's closure code name.
TOPdesk.Incident.TimeSpentNumberTOPdesk incident's time spent.
TOPdesk.Incident.TimeSpentFirstLineNumberTOPdesk incident's time spent first line
TOPdesk.Incident.TimeSpentSecondLineAndPartialsNumberTOPdesk incident's time spent second line and partials.
TOPdesk.Incident.CostsNumberTOPdesk incident's costs.
TOPdesk.Incident.EscalationStatusStringTOPdesk incident's escalation status.
TOPdesk.Incident.EscalationReason.IdStringTOPdesk incident's escalation reason ID.
TOPdesk.Incident.EscalationReason.NameStringTOPdesk incident's escalation reason name.
TOPdesk.Incident.EscalationOperator.IdStringTOPdesk incident's escalation operator ID.
TOPdesk.Incident.EscalationOperator.NameStringTOPdesk incident's escalation operator name.
TOPdesk.Incident.CallDateDateTOPdesk incident's call date.
TOPdesk.Incident.Creator.IdStringTOPdesk incident's creator ID.
TOPdesk.Incident.Creator.NameStringTOPdesk incident's creator name.
TOPdesk.Incident.CreationDateDateTOPdesk incident's creation date.
TOPdesk.Incident.Modifier.IdStringTOPdesk incident's modifier ID.
TOPdesk.Incident.Modifier.NameStringTOPdesk incident's modifier name.
TOPdesk.Incident.ModificationDateDateTOPdesk incident's modification date.
TOPdesk.Incident.MajorCallBooleanTOPdesk incident's major call.
TOPdesk.Incident.MajorCallObject.NameStringTOPdesk incident's Major call object name.
TOPdesk.Incident.MajorCallObject.IdStringTOPdesk incident's major call object ID.
TOPdesk.Incident.MajorCallObject.StatusNumberTOPdesk incident's major call object status.
TOPdesk.Incident.MajorCallObject.MajorIncidentBooleanTOPdesk incident's major call object major incident.
TOPdesk.Incident.PublishToSsdBooleanTOPdesk incident's publish to SSD.
TOPdesk.Incident.MonitoredBooleanTOPdesk incident's monitored.
TOPdesk.Incident.ExpectedTimeSpentNumberTOPdesk incident's expected time spent.
TOPdesk.Incident.MainIncidentUnknownTOPdesk incident's main incident.
TOPdesk.Incident.PartialIncidents.LinkStringTOPdesk incident's partial incidents link.
TOPdesk.Incident.OptionalFields1.Boolean1BooleanTOPdesk incident's optional fields1 boolean1.
TOPdesk.Incident.OptionalFields1.Boolean2BooleanTOPdesk incident's optional fields1 boolean2.
TOPdesk.Incident.OptionalFields1.Boolean3BooleanTOPdesk incident's optional fields1 boolean3.
TOPdesk.Incident.OptionalFields1.Boolean4BooleanTOPdesk incident's optional fields1 boolean4.
TOPdesk.Incident.OptionalFields1.Boolean5BooleanTOPdesk incident's optional fields1 boolean5.
TOPdesk.Incident.OptionalFields1.Number1NumberTOPdesk incident's optional fields1 number1.
TOPdesk.Incident.OptionalFields1.Number2NumberTOPdesk incident's optional fields1 number2.
TOPdesk.Incident.OptionalFields1.Number3NumberTOPdesk incident's optional fields1 number3.
TOPdesk.Incident.OptionalFields1.Number4NumberTOPdesk incident's optional fields1 number4.
TOPdesk.Incident.OptionalFields1.Number5NumberTOPdesk incident's optional fields1 number5.
TOPdesk.Incident.OptionalFields1.Date1DateTOPdesk incident's optional fields1 date1.
TOPdesk.Incident.OptionalFields1.Date2DateTOPdesk incident's optional fields1 date2.
TOPdesk.Incident.OptionalFields1.Date3DateTOPdesk incident's optional fields1 date3.
TOPdesk.Incident.OptionalFields1.Date4DateTOPdesk incident's optional fields1 date4.
TOPdesk.Incident.OptionalFields1.Date5DateTOPdesk incident's optional fields1 date5.
TOPdesk.Incident.OptionalFields1.Text1StringTOPdesk incident's optional fields1 text1.
TOPdesk.Incident.OptionalFields1.Text2StringTOPdesk incident's optional fields1 text2.
TOPdesk.Incident.OptionalFields1.Text3StringTOPdesk incident's optional fields1 text3.
TOPdesk.Incident.OptionalFields1.Text4StringTOPdesk incident's optional fields1 text4.
TOPdesk.Incident.OptionalFields1.Text5StringTOPdesk incident's optional fields1 text5.
TOPdesk.Incident.OptionalFields1.Memo1StringTOPdesk incident's optional fields1 memo1.
TOPdesk.Incident.OptionalFields1.Memo2StringTOPdesk incident's optional fields1 memo2.
TOPdesk.Incident.OptionalFields1.Memo3StringTOPdesk incident's optional fields1 memo3.
TOPdesk.Incident.OptionalFields1.Memo4StringTOPdesk incident's optional fields1 memo4.
TOPdesk.Incident.OptionalFields1.Memo5StringTOPdesk incident's optional fields1 memo5.
TOPdesk.Incident.OptionalFields1.Searchlist1.IdStringTOPdesk incident's optional fields1 searchlist1 ID.
TOPdesk.Incident.OptionalFields1.Searchlist1.NameStringTOPdesk incident's optional fields1 searchlist1 name.
TOPdesk.Incident.OptionalFields1.Searchlist2.IdStringTOPdesk incident's optional fields1 searchlist2 ID.
TOPdesk.Incident.OptionalFields1.Searchlist2.NameStringTOPdesk incident's optional fields1 searchlist2 name.
TOPdesk.Incident.OptionalFields1.Searchlist3.IdStringTOPdesk incident's optional fields1 searchlist3 ID.
TOPdesk.Incident.OptionalFields1.Searchlist3.NameStringTOPdesk incident's optional fields1 searchlist3 name.
TOPdesk.Incident.OptionalFields1.Searchlist4.IdStringTOPdesk incident's optional fields1 searchlist4 ID.
TOPdesk.Incident.OptionalFields1.Searchlist4.NameStringTOPdesk incident's optional fields1 searchlist4 name.
TOPdesk.Incident.OptionalFields1.Searchlist5.IdStringTOPdesk incident's optional fields1 searchlist5 ID.
TOPdesk.Incident.OptionalFields1.Searchlist5.NameStringTOPdesk incident's optional fields1 searchlist5 name.
TOPdesk.Incident.OptionalFields2.Boolean1BooleanTOPdesk incident's optional fields2 boolean1.
TOPdesk.Incident.OptionalFields2.Boolean2BooleanTOPdesk incident's optional fields2 boolean2.
TOPdesk.Incident.OptionalFields2.Boolean3BooleanTOPdesk incident's optional fields2 boolean3.
TOPdesk.Incident.OptionalFields2.Boolean4BooleanTOPdesk incident's optional fields2 boolean4.
TOPdesk.Incident.OptionalFields2.Boolean5BooleanTOPdesk incident's optional fields2 boolean5.
TOPdesk.Incident.OptionalFields2.Number1NumberTOPdesk incident's optional fields2 number1.
TOPdesk.Incident.OptionalFields2.Number2NumberTOPdesk incident's optional fields2 number2.
TOPdesk.Incident.OptionalFields2.Number3NumberTOPdesk incident's optional fields2 number3.
TOPdesk.Incident.OptionalFields2.Number4NumberTOPdesk incident's optional fields2 number4.
TOPdesk.Incident.OptionalFields2.Number5NumberTOPdesk incident's optional fields2 number5.
TOPdesk.Incident.OptionalFields2.Date1DateTOPdesk incident's optional fields2 date1.
TOPdesk.Incident.OptionalFields2.Date2DateTOPdesk incident's optional fields2 date2.
TOPdesk.Incident.OptionalFields2.Date3DateTOPdesk incident's optional fields2 date3.
TOPdesk.Incident.OptionalFields2.Date4DateTOPdesk incident's optional fields2 date4.
TOPdesk.Incident.OptionalFields2.Date5DateTOPdesk incident's optional fields2 date5.
TOPdesk.Incident.OptionalFields2.Text1StringTOPdesk incident's optional fields2 text1.
TOPdesk.Incident.OptionalFields2.Text2StringTOPdesk incident's optional fields2 text2.
TOPdesk.Incident.OptionalFields2.Text3StringTOPdesk incident's optional fields2.text3.
TOPdesk.Incident.OptionalFields2.Text4StringTOPdesk incident's optional fields2 text4.
TOPdesk.Incident.OptionalFields2.Text5StringTOPdesk incident's optional fields2 text5.
TOPdesk.Incident.OptionalFields2.Memo1StringTOPdesk incident's optional fields2 memo1.
TOPdesk.Incident.OptionalFields2.Memo2StringTOPdesk incident's optional fields2 memo2.
TOPdesk.Incident.OptionalFields2.Memo3StringTOPdesk incident's optional fields2 memo3.
TOPdesk.Incident.OptionalFields2.Memo4StringTOPdesk incident's optional fields2 memo4.
TOPdesk.Incident.OptionalFields2.Memo5StringTOPdesk incident's optional fields2 memo5.
TOPdesk.Incident.OptionalFields2.Searchlist1.IdStringTOPdesk incident's optional fields2 searchlist1 ID.
TOPdesk.Incident.OptionalFields2.Searchlist1.NameStringTOPdesk incident's optional fields2 searchlist1 name.
TOPdesk.Incident.OptionalFields2.Searchlist2.IdStringTOPdesk incident's optional fields2 searchlist2 ID.
TOPdesk.Incident.OptionalFields2.Searchlist2.NameStringTOPdesk incident's optional fields2 searchlist2 name.
TOPdesk.Incident.OptionalFields2.Searchlist3.IdStringTOPdesk incident's optional fields2 searchlist3 ID.
TOPdesk.Incident.OptionalFields2.Searchlist3.NameStringTOPdesk incident's optional fields2 searchlist3 name.
TOPdesk.Incident.OptionalFields2.Searchlist4.IdStringTOPdesk incident's optional fields2 searchlist4 ID.
TOPdesk.Incident.OptionalFields2.Searchlist4.NameStringTOPdesk incident's optional fields2 searchlist4 name.
TOPdesk.Incident.OptionalFields2.Searchlist5.IdStringTOPdesk incident's optional fields2 searchlist5 ID.
TOPdesk.Incident.OptionalFields2.Searchlist5.NameStringTOPdesk incident's optional fields2 searchlist5 name.
TOPdesk.Incident.ExternalLinks.IdStringTOPdesk incident's external links ID.
TOPdesk.Incident.ExternalLinks.TypeStringTOPdesk incident's external links type.
TOPdesk.Incident.ExternalLinks.DateDateTOPdesk incident's external links date.

Command Example#

!topdesk-incident-unarchive number=XSOAR-1337

Context Example#

{
"TOPdesk": {
"Incident": {
"Action": "/tas/api/incidents/id/some-id/actions",
"Attachments": "/tas/api/incidents/id/some-id/attachments",
"BriefDescription": "",
"CallDate": "2021-03-21T17:38:03.007+0000",
"Caller": {
"Branch": {
"ClientReferenceNumber": null,
"ExtraA": null,
"ExtraB": null,
"Id": null,
"Name": "",
"TimeZone": null
},
"DynamicName": "xsoar_test"
},
"Closed": false,
"Completed": false,
"CreationDate": "2021-03-21T17:38:03.007+0000",
"Creator": {
"Id": "some-operator-id",
"Name": "Xsoar - Operator"
},
"ExternalNumber": "",
"Id": "some-id",
"MajorCall": false,
"ModificationDate": "2021-03-24T08:15:06.000+0000",
"Modifier": {
"Id": "some-operator-id",
"Name": "Xsoar - Operator"
},
"Monitored": false,
"Number": "XSOAR-1337",
"OnHold": false,
"OptionalFields1": {
"Searchlist1": {
"Id": "some-id-33",
"Name": "Searchlist 1"
},
"Searchlist3": {
"Id": "some-id-34",
"Name": "Searchlist 3"
},
"Text1": "",
"Text2": "",
"Text3": "",
"Text4": "",
"Text5": ""
},
"OptionalFields2": {
"Text1": "",
"Text2": "",
"Text3": "",
"Text4": "",
"Text5": ""
},
"ProcessingStatus": {
"Id": "some-processing-id",
"Name": "Logged"
},
"PublishToSsd": false,
"Requests": "/tas/api/incidents/id/some-id/requests",
"Responded": false,
"Status": "firstLine"
}
}
}

Human Readable Output#

TOPdesk incidents#

IdNumberLineCallerNameStatus
some-idXSOAR-1337firstLinexsoar_testLogged

topdesk-incident-attachment-upload#

Upload an attachment to an incident in TOPdesk.

Permissions#

Operator: With edit permission on 1st/2nd line incident; Category/Branch/Operator filters apply

Person: Accessible; Person visibility settings apply.

Base Command#

topdesk-incident-attachment-upload

Input#

Argument NameDescriptionRequired
idThe incident ID. An ID or a number must be set. If both are set incident with relevant ID will be updated.Optional
number.The incident number. An ID or a number must be set. If both are set incident with relevant ID will be updated.Optional
fileEntry ID of the file to upload.Required
file_nameIn case specified entry contains more than one file, the given file name will be used. If not specified the first file in the entry will be used.Optional
invisible_for_callerWhether the uploaded file is invisible for the caller of the incident. Possible values are: true, false.Optional
file_descriptionThe description of the uploaded file.Optional

Context Output#

PathTypeDescription
TOPdesk.Attachment.IdStringAttachment's ID.
TOPdesk.Attachment.FileNameStringAttachment's file name.
TOPdesk.Attachment.DownloadUrlStringAttachment's download URL.
TOPdesk.Attachment.SizeNumberAttachment's size.
TOPdesk.Attachment.DescriptionStringAttachment's description.
TOPdesk.Attachment.InvisibleForCallerBooleanAttachment's invisible for caller.
TOPdesk.Attachment.EntryDateDateAttachment's entry date.
TOPdesk.Attachment.Operator.IdStringAttachment's operator ID.
TOPdesk.Attachment.Operator.NameStringAttachment's operator name.
TOPdesk.Attachment.PersonUnknownAttachment's person.

Command Example#

!topdesk-incident-attachment-upload number=XSOAR-1337 file=932@some-file-entry

Context Example#

{
"TOPdesk": {
"Attachment": {
"DownloadUrl": "/tas/api/incidents/id/some-incident-id/attachments/some-id/download",
"EntryDate": "2021-03-24T13:40:47.000+0000",
"FileName": "tiny_upload_file",
"Id": "some-id",
"InvisibleForCaller": false,
"Operator": {
"Id": "some-operator-id",
"Name": "xsoar operator a"
}
}
}
}

Human Readable Output#

TOPdesk Attachments#

IdFileNameDownloadUrlInvisibleForCallerEntryDateOperator
some-idtiny_upload_file/tas/api/incidents/id/some-incident-id/attachments/some-id/downloadFalse2021-03-24T13:40:47.000+0000xsoar operator a

Base Command#

topdesk-incident-attachments-list

Input#

Argument NameDescriptionRequired
idThe incident ID. An ID or a number must be set. If both are set incident with relevant ID will be updated.Optional
number.The incident number. An ID or a number must be set. If both are set incident with relevant ID will be updated.Optional
limitThe limit for the amount of attachments to store in the Context Data. -1 stores all categories. Default value is 100.Optional

Context Output#

PathTypeDescription
TOPdesk.Attachment.IdStringAttachment's ID.
TOPdesk.Attachment.FileNameStringAttachment's file name.
TOPdesk.Attachment.DownloadUrlStringAttachment's download URL.
TOPdesk.Attachment.SizeNumberAttachment's size.
TOPdesk.Attachment.DescriptionStringAttachment's description.
TOPdesk.Attachment.InvisibleForCallerBooleanAttachment's invisible for caller.
TOPdesk.Attachment.EntryDateDateAttachment's entry date.
TOPdesk.Attachment.Operator.IdStringAttachment's operator ID.
TOPdesk.Attachment.Operator.NameStringAttachment's operator name.
TOPdesk.Attachment.PersonUnknownAttachment's person.

Command Example#

!topdesk-incident-attachments-list number=XSOAR-1337

Context Example#

{
"TOPdesk": {
"Attachment": {
"DownloadUrl": "/tas/api/incidents/id/some-incident-id/attachments/some-id/download",
"EntryDate": "2021-03-24T13:40:47.000+0000",
"FileName": "tiny_upload_file",
"Id": "some-id",
"InvisibleForCaller": false,
"Operator": {
"Id": "some-operator-id",
"Name": "xsoar operator a"
}
}
}
}

Human Readable Output#

TOPdesk Attachments#

IdFileNameDownloadUrlInvisibleForCallerEntryDateOperator
some-idtiny_upload_file/tas/api/incidents/id/some-incident-id/attachments/some-id/downloadFalse2021-03-24T13:40:47.000+0000xsoar operator a
Edit this page
Report an Issue