/HelloID-Task-SA-Target-TOPdesk-OperatorUnarchive

TOPdesk - Operator unarchive

Primary LanguagePowerShell

HelloID-Task-SA-Target-TOPdesk-OperatorUnarchive

Prerequisites

  • TOPdesk API Username and Key
  • User-defined variables: topdeskBaseUrl, topdeskApiUsername and topdeskApiSecret created in your HelloID portal.

Description

This code snippet will unarchive an existing operator within TOPdesk and executes the following tasks:

  1. Define a hash table $formObject. The keys of the hash table represent the properties necessary to unarchive an existing operator within TOPdesk, while the values represent the values entered in the form.

To view an example of the form output, please refer to the JSON code pasted below.

{
    "id": "634206ca-6907-4914-8509-da55cfd8b35d",
    "displayName": "Doe, John van der",
    "archivingReasonId" : "73736b19-a69e-5e6b-b6af-ddc655fead0c"
}

❗ It is important to note that the names of your form fields might differ. Ensure that the $formObject hash table is appropriately adjusted to match your form fields. See the TOPdesk API Docs page

  1. Creates authorization headers using the provided API key and secret.

  2. Unarchive an existing operator using the: Invoke-RestMethod cmdlet. The hash table called: $formObject is passed to the body of the: Invoke-RestMethod cmdlet as a JSON object.